@apollo/client 4.0.0-rc.8 → 4.0.0

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 (277) hide show
  1. package/CHANGELOG.md +2488 -0
  2. package/README.md +6 -2
  3. package/__cjs/cache/inmemory/inMemoryCache.cjs +2 -2
  4. package/__cjs/cache/inmemory/inMemoryCache.cjs.map +1 -1
  5. package/__cjs/cache/inmemory/policies.cjs +18 -12
  6. package/__cjs/cache/inmemory/policies.cjs.map +1 -1
  7. package/__cjs/cache/inmemory/writeToStore.cjs +1 -1
  8. package/__cjs/cache/inmemory/writeToStore.cjs.map +1 -1
  9. package/__cjs/core/ObservableQuery.cjs +1 -1
  10. package/__cjs/core/ObservableQuery.cjs.map +1 -1
  11. package/__cjs/core/ObservableQuery.d.cts +1 -1
  12. package/__cjs/core/QueryInfo.cjs +2 -6
  13. package/__cjs/core/QueryInfo.cjs.map +1 -1
  14. package/__cjs/core/index.cjs.map +1 -1
  15. package/__cjs/core/index.d.cts +1 -1
  16. package/__cjs/incremental/handlers/defer20220824.cjs.map +1 -1
  17. package/__cjs/incremental/handlers/defer20220824.d.cts +9 -6
  18. package/__cjs/incremental/handlers/notImplemented.cjs.map +1 -1
  19. package/__cjs/incremental/handlers/notImplemented.d.cts +11 -0
  20. package/__cjs/link/batch/batchLink.cjs +30 -2
  21. package/__cjs/link/batch/batchLink.cjs.map +1 -1
  22. package/__cjs/link/batch/batchLink.d.cts +69 -2
  23. package/__cjs/link/batch-http/BaseBatchHttpLink.cjs +156 -0
  24. package/__cjs/link/batch-http/BaseBatchHttpLink.cjs.map +1 -0
  25. package/__cjs/link/batch-http/BaseBatchHttpLink.d.cts +68 -0
  26. package/__cjs/link/batch-http/batchHttpLink.cjs +3 -128
  27. package/__cjs/link/batch-http/batchHttpLink.cjs.map +1 -1
  28. package/__cjs/link/batch-http/batchHttpLink.d.cts +4 -20
  29. package/__cjs/link/batch-http/index.cjs +2 -1
  30. package/__cjs/link/batch-http/index.cjs.map +1 -1
  31. package/__cjs/link/batch-http/index.d.cts +2 -1
  32. package/__cjs/link/client-awareness/ClientAwarenessLink.cjs +3 -3
  33. package/__cjs/link/client-awareness/ClientAwarenessLink.cjs.map +1 -1
  34. package/__cjs/link/client-awareness/ClientAwarenessLink.d.cts +20 -1
  35. package/__cjs/link/context/index.cjs +19 -0
  36. package/__cjs/link/context/index.cjs.map +1 -1
  37. package/__cjs/link/context/index.d.cts +64 -2
  38. package/__cjs/link/core/ApolloLink.cjs.map +1 -1
  39. package/__cjs/link/core/ApolloLink.d.cts +5 -2
  40. package/__cjs/link/core/types.d.cts +0 -4
  41. package/__cjs/link/http/BaseHttpLink.cjs +59 -8
  42. package/__cjs/link/http/BaseHttpLink.cjs.map +1 -1
  43. package/__cjs/link/http/BaseHttpLink.d.cts +256 -2
  44. package/__cjs/link/http/HttpLink.cjs +1 -1
  45. package/__cjs/link/http/HttpLink.cjs.map +1 -1
  46. package/__cjs/link/http/HttpLink.d.cts +5 -208
  47. package/__cjs/link/http/rewriteURIForGET.cjs.map +1 -1
  48. package/__cjs/link/http/rewriteURIForGET.d.cts +2 -2
  49. package/__cjs/link/http/selectHttpOptionsAndBody.cjs.map +1 -1
  50. package/__cjs/link/http/selectHttpOptionsAndBody.d.cts +7 -7
  51. package/__cjs/link/index.cjs.map +1 -1
  52. package/__cjs/link/index.d.cts +2 -1
  53. package/__cjs/link/persisted-queries/index.cjs +16 -0
  54. package/__cjs/link/persisted-queries/index.cjs.map +1 -1
  55. package/__cjs/link/persisted-queries/index.d.cts +181 -0
  56. package/__cjs/link/remove-typename/removeTypenameFromVariables.cjs +48 -0
  57. package/__cjs/link/remove-typename/removeTypenameFromVariables.cjs.map +1 -1
  58. package/__cjs/link/remove-typename/removeTypenameFromVariables.d.cts +115 -0
  59. package/__cjs/link/retry/retryLink.cjs +25 -3
  60. package/__cjs/link/retry/retryLink.cjs.map +1 -1
  61. package/__cjs/link/retry/retryLink.d.cts +82 -9
  62. package/__cjs/link/schema/index.cjs +20 -0
  63. package/__cjs/link/schema/index.cjs.map +1 -1
  64. package/__cjs/link/schema/index.d.cts +128 -6
  65. package/__cjs/link/ws/index.cjs +18 -0
  66. package/__cjs/link/ws/index.cjs.map +1 -1
  67. package/__cjs/link/ws/index.d.cts +56 -5
  68. package/__cjs/local-state/LocalState.cjs.map +1 -1
  69. package/__cjs/masking/GraphQLCodegenDataMasking.d.cts +10 -42
  70. package/__cjs/masking/PreserveTypes.cjs +3 -0
  71. package/__cjs/masking/PreserveTypes.cjs.map +1 -0
  72. package/__cjs/masking/PreserveTypes.d.cts +26 -0
  73. package/__cjs/masking/index.cjs.map +1 -1
  74. package/__cjs/masking/index.d.cts +1 -1
  75. package/__cjs/masking/internal/types.d.cts +0 -1
  76. package/__cjs/masking/types.d.cts +6 -23
  77. package/__cjs/react/hooks/useBackgroundQuery.cjs.map +1 -1
  78. package/__cjs/react/hooks/useBackgroundQuery.d.cts +2 -1
  79. package/__cjs/react/hooks/useLazyQuery.d.cts +1 -1
  80. package/__cjs/react/hooks/useLoadableQuery.cjs.map +1 -1
  81. package/__cjs/react/hooks/useLoadableQuery.d.cts +2 -1
  82. package/__cjs/react/hooks/useQuery.d.cts +1 -1
  83. package/__cjs/react/hooks/useQueryRefHandlers.cjs.map +1 -1
  84. package/__cjs/react/hooks/useQueryRefHandlers.d.cts +2 -1
  85. package/__cjs/react/hooks/useReadQuery.cjs.map +1 -1
  86. package/__cjs/react/hooks/useReadQuery.d.cts +1 -1
  87. package/__cjs/react/hooks/useSyncExternalStore.cjs +2 -6
  88. package/__cjs/react/hooks/useSyncExternalStore.cjs.map +1 -1
  89. package/__cjs/react/query-preloader/createQueryPreloader.cjs.map +1 -1
  90. package/__cjs/react/query-preloader/createQueryPreloader.d.cts +1 -1
  91. package/__cjs/react/types/deprecated.d.cts +1 -1
  92. package/__cjs/react/types/types.documentation.d.cts +1 -1
  93. package/__cjs/testing/core/mocking/mockSubscriptionLink.d.cts +1 -1
  94. package/__cjs/testing/react/MockedProvider.cjs.map +1 -1
  95. package/__cjs/testing/react/MockedProvider.d.cts +5 -0
  96. package/__cjs/utilities/common/stripTypename.cjs +11 -0
  97. package/__cjs/utilities/common/stripTypename.cjs.map +1 -1
  98. package/__cjs/utilities/common/stripTypename.d.cts +11 -0
  99. package/__cjs/utilities/graphql/DocumentTransform.cjs +84 -1
  100. package/__cjs/utilities/graphql/DocumentTransform.cjs.map +1 -1
  101. package/__cjs/utilities/graphql/DocumentTransform.d.cts +94 -5
  102. package/__cjs/utilities/graphql/isFormattedExecutionResult.cjs +27 -0
  103. package/__cjs/utilities/graphql/isFormattedExecutionResult.cjs.map +1 -1
  104. package/__cjs/utilities/graphql/isFormattedExecutionResult.d.cts +27 -0
  105. package/__cjs/utilities/graphql/operations.cjs +54 -3
  106. package/__cjs/utilities/graphql/operations.cjs.map +1 -1
  107. package/__cjs/utilities/graphql/operations.d.cts +54 -3
  108. package/__cjs/utilities/graphql/storeUtils.cjs +9 -0
  109. package/__cjs/utilities/graphql/storeUtils.cjs.map +1 -1
  110. package/__cjs/utilities/graphql/storeUtils.d.cts +9 -0
  111. package/__cjs/utilities/graphql/transform.cjs +12 -1
  112. package/__cjs/utilities/graphql/transform.cjs.map +1 -1
  113. package/__cjs/utilities/graphql/transform.d.cts +12 -1
  114. package/__cjs/utilities/internal/canonicalStringify.cjs +30 -7
  115. package/__cjs/utilities/internal/canonicalStringify.cjs.map +1 -1
  116. package/__cjs/utilities/internal/canonicalStringify.d.cts +30 -7
  117. package/__cjs/utilities/internal/getMainDefinition.cjs +36 -8
  118. package/__cjs/utilities/internal/getMainDefinition.cjs.map +1 -1
  119. package/__cjs/utilities/internal/getMainDefinition.d.cts +36 -8
  120. package/__cjs/utilities/internal/removeDirectivesFromDocument.cjs +2 -6
  121. package/__cjs/utilities/internal/removeDirectivesFromDocument.cjs.map +1 -1
  122. package/__cjs/utilities/internal/types/DocumentationTypes.d.cts +1 -1
  123. package/__cjs/utilities/subscriptions/relay/index.cjs.map +1 -1
  124. package/__cjs/v4-migration.cjs +9 -0
  125. package/__cjs/v4-migration.cjs.map +1 -0
  126. package/__cjs/v4-migration.d.cts +826 -0
  127. package/__cjs/version.cjs +1 -1
  128. package/__cjs/version.cjs.map +1 -1
  129. package/cache/inmemory/inMemoryCache.js +2 -2
  130. package/cache/inmemory/inMemoryCache.js.map +1 -1
  131. package/cache/inmemory/policies.js +18 -12
  132. package/cache/inmemory/policies.js.map +1 -1
  133. package/cache/inmemory/writeToStore.js +1 -1
  134. package/cache/inmemory/writeToStore.js.map +1 -1
  135. package/core/ObservableQuery.d.ts +1 -1
  136. package/core/ObservableQuery.js +1 -1
  137. package/core/ObservableQuery.js.map +1 -1
  138. package/core/QueryInfo.js +1 -2
  139. package/core/QueryInfo.js.map +1 -1
  140. package/core/index.d.ts +1 -1
  141. package/core/index.js.map +1 -1
  142. package/incremental/handlers/defer20220824.d.ts +9 -6
  143. package/incremental/handlers/defer20220824.js.map +1 -1
  144. package/incremental/handlers/notImplemented.d.ts +11 -0
  145. package/incremental/handlers/notImplemented.js.map +1 -1
  146. package/legacyEntryPoints/v4-migration/index.d.ts +1 -0
  147. package/legacyEntryPoints/v4-migration/index.js +1 -0
  148. package/legacyEntryPoints/v4-migration/v4-migration.cjs +1 -0
  149. package/legacyEntryPoints/v4-migration/v4-migration.d.cts +1 -0
  150. package/link/batch/batchLink.d.ts +69 -2
  151. package/link/batch/batchLink.js +30 -2
  152. package/link/batch/batchLink.js.map +1 -1
  153. package/link/batch-http/BaseBatchHttpLink.d.ts +68 -0
  154. package/link/batch-http/BaseBatchHttpLink.js +152 -0
  155. package/link/batch-http/BaseBatchHttpLink.js.map +1 -0
  156. package/link/batch-http/batchHttpLink.d.ts +5 -21
  157. package/link/batch-http/batchHttpLink.js +1 -125
  158. package/link/batch-http/batchHttpLink.js.map +1 -1
  159. package/link/batch-http/index.d.ts +2 -1
  160. package/link/batch-http/index.js +2 -1
  161. package/link/batch-http/index.js.map +1 -1
  162. package/link/client-awareness/ClientAwarenessLink.d.ts +21 -2
  163. package/link/client-awareness/ClientAwarenessLink.js +3 -3
  164. package/link/client-awareness/ClientAwarenessLink.js.map +1 -1
  165. package/link/context/index.d.ts +65 -3
  166. package/link/context/index.js +19 -0
  167. package/link/context/index.js.map +1 -1
  168. package/link/core/ApolloLink.d.ts +5 -2
  169. package/link/core/ApolloLink.js.map +1 -1
  170. package/link/core/types.d.ts +0 -4
  171. package/link/core/types.js.map +1 -1
  172. package/link/http/BaseHttpLink.d.ts +257 -3
  173. package/link/http/BaseHttpLink.js +59 -8
  174. package/link/http/BaseHttpLink.js.map +1 -1
  175. package/link/http/HttpLink.d.ts +6 -209
  176. package/link/http/HttpLink.js +1 -1
  177. package/link/http/HttpLink.js.map +1 -1
  178. package/link/http/rewriteURIForGET.d.ts +2 -2
  179. package/link/http/rewriteURIForGET.js.map +1 -1
  180. package/link/http/selectHttpOptionsAndBody.d.ts +7 -7
  181. package/link/http/selectHttpOptionsAndBody.js.map +1 -1
  182. package/link/index.d.ts +2 -1
  183. package/link/index.js.map +1 -1
  184. package/link/persisted-queries/index.d.ts +182 -1
  185. package/link/persisted-queries/index.js +16 -0
  186. package/link/persisted-queries/index.js.map +1 -1
  187. package/link/remove-typename/removeTypenameFromVariables.d.ts +115 -0
  188. package/link/remove-typename/removeTypenameFromVariables.js +48 -0
  189. package/link/remove-typename/removeTypenameFromVariables.js.map +1 -1
  190. package/link/retry/retryLink.d.ts +83 -10
  191. package/link/retry/retryLink.js +25 -3
  192. package/link/retry/retryLink.js.map +1 -1
  193. package/link/schema/index.d.ts +129 -7
  194. package/link/schema/index.js +20 -0
  195. package/link/schema/index.js.map +1 -1
  196. package/link/ws/index.d.ts +56 -5
  197. package/link/ws/index.js +18 -0
  198. package/link/ws/index.js.map +1 -1
  199. package/local-state/LocalState.js.map +1 -1
  200. package/masking/GraphQLCodegenDataMasking.d.ts +10 -42
  201. package/masking/GraphQLCodegenDataMasking.js.map +1 -1
  202. package/masking/PreserveTypes.d.ts +26 -0
  203. package/masking/PreserveTypes.js +2 -0
  204. package/masking/PreserveTypes.js.map +1 -0
  205. package/masking/index.d.ts +1 -1
  206. package/masking/index.js.map +1 -1
  207. package/masking/internal/types.d.ts +0 -1
  208. package/masking/internal/types.js.map +1 -1
  209. package/masking/types.d.ts +6 -23
  210. package/masking/types.js.map +1 -1
  211. package/package.json +8 -2
  212. package/react/hooks/useBackgroundQuery.d.ts +2 -1
  213. package/react/hooks/useBackgroundQuery.js.map +1 -1
  214. package/react/hooks/useLazyQuery.d.ts +1 -1
  215. package/react/hooks/useLoadableQuery.d.ts +2 -1
  216. package/react/hooks/useLoadableQuery.js.map +1 -1
  217. package/react/hooks/useQuery.d.ts +1 -1
  218. package/react/hooks/useQueryRefHandlers.d.ts +2 -1
  219. package/react/hooks/useQueryRefHandlers.js.map +1 -1
  220. package/react/hooks/useReadQuery.d.ts +1 -1
  221. package/react/hooks/useReadQuery.js.map +1 -1
  222. package/react/hooks/useSyncExternalStore.js +1 -1
  223. package/react/hooks/useSyncExternalStore.js.map +1 -1
  224. package/react/hooks-compiled/useBackgroundQuery.d.ts +2 -1
  225. package/react/hooks-compiled/useBackgroundQuery.js.map +1 -1
  226. package/react/hooks-compiled/useLazyQuery.d.ts +1 -1
  227. package/react/hooks-compiled/useLoadableQuery.d.ts +2 -1
  228. package/react/hooks-compiled/useLoadableQuery.js.map +1 -1
  229. package/react/hooks-compiled/useQuery.d.ts +1 -1
  230. package/react/hooks-compiled/useQueryRefHandlers.d.ts +2 -1
  231. package/react/hooks-compiled/useQueryRefHandlers.js.map +1 -1
  232. package/react/hooks-compiled/useReadQuery.d.ts +1 -1
  233. package/react/hooks-compiled/useReadQuery.js.map +1 -1
  234. package/react/hooks-compiled/useSyncExternalStore.js +1 -1
  235. package/react/hooks-compiled/useSyncExternalStore.js.map +1 -1
  236. package/react/query-preloader/createQueryPreloader.d.ts +1 -1
  237. package/react/query-preloader/createQueryPreloader.js.map +1 -1
  238. package/react/types/deprecated.d.ts +1 -1
  239. package/react/types/deprecated.js.map +1 -1
  240. package/react/types/types.documentation.d.ts +1 -1
  241. package/react/types/types.documentation.js.map +1 -1
  242. package/testing/core/mocking/mockSubscriptionLink.d.ts +1 -1
  243. package/testing/react/MockedProvider.d.ts +5 -0
  244. package/testing/react/MockedProvider.js.map +1 -1
  245. package/utilities/common/stripTypename.d.ts +11 -0
  246. package/utilities/common/stripTypename.js +11 -0
  247. package/utilities/common/stripTypename.js.map +1 -1
  248. package/utilities/graphql/DocumentTransform.d.ts +94 -5
  249. package/utilities/graphql/DocumentTransform.js +84 -1
  250. package/utilities/graphql/DocumentTransform.js.map +1 -1
  251. package/utilities/graphql/isFormattedExecutionResult.d.ts +27 -0
  252. package/utilities/graphql/isFormattedExecutionResult.js +27 -0
  253. package/utilities/graphql/isFormattedExecutionResult.js.map +1 -1
  254. package/utilities/graphql/operations.d.ts +54 -3
  255. package/utilities/graphql/operations.js +54 -3
  256. package/utilities/graphql/operations.js.map +1 -1
  257. package/utilities/graphql/storeUtils.d.ts +9 -0
  258. package/utilities/graphql/storeUtils.js +9 -0
  259. package/utilities/graphql/storeUtils.js.map +1 -1
  260. package/utilities/graphql/transform.d.ts +12 -1
  261. package/utilities/graphql/transform.js +12 -1
  262. package/utilities/graphql/transform.js.map +1 -1
  263. package/utilities/internal/canonicalStringify.d.ts +30 -7
  264. package/utilities/internal/canonicalStringify.js +30 -7
  265. package/utilities/internal/canonicalStringify.js.map +1 -1
  266. package/utilities/internal/getMainDefinition.d.ts +37 -9
  267. package/utilities/internal/getMainDefinition.js +36 -8
  268. package/utilities/internal/getMainDefinition.js.map +1 -1
  269. package/utilities/internal/removeDirectivesFromDocument.js +1 -2
  270. package/utilities/internal/removeDirectivesFromDocument.js.map +1 -1
  271. package/utilities/internal/types/DocumentationTypes.d.ts +1 -1
  272. package/utilities/subscriptions/relay/index.js.map +1 -1
  273. package/v4-migration.d.ts +826 -0
  274. package/v4-migration.js +8 -0
  275. package/v4-migration.js.map +1 -0
  276. package/version.js +1 -1
  277. package/version.js.map +1 -1
@@ -1,10 +1,104 @@
1
1
  import { ApolloLink } from "@apollo/client/link";
2
+ /**
3
+ * Sentinel value used to indicate that `__typename` fields should be kept
4
+ * for a specific field or input type.
5
+ *
6
+ * @remarks
7
+ * Use this value in the `except` configuration to preserve `__typename`
8
+ * fields in JSON scalar fields or other cases where you need to retain
9
+ * the typename information.
10
+ *
11
+ * @example
12
+ *
13
+ * ```ts
14
+ * import {
15
+ * RemoveTypenameFromVariablesLink,
16
+ * KEEP,
17
+ * } from "@apollo/client/link/remove-typename";
18
+ *
19
+ * const link = new RemoveTypenameFromVariablesLink({
20
+ * except: {
21
+ * JSON: KEEP, // Keep __typename for all JSON scalar variables
22
+ * DashboardInput: {
23
+ * config: KEEP, // Keep __typename only for the config field
24
+ * },
25
+ * },
26
+ * });
27
+ * ```
28
+ */
2
29
  export declare const KEEP = "__KEEP";
3
30
  export declare namespace RemoveTypenameFromVariablesLink {
31
+ /**
32
+ * Configuration object that specifies which input types and fields should
33
+ * retain their `__typename` fields.
34
+ *
35
+ * @remarks
36
+ * This is a recursive configuration where:
37
+ *
38
+ * - Keys represent GraphQL input type names or field names
39
+ * - Values can be either the `KEEP` sentinel to preserve all `__typename`
40
+ * fields, or a nested `KeepTypenameConfig` to preserve `__typename` fields on
41
+ * a specific field name.
42
+ *
43
+ * @example
44
+ *
45
+ * ```ts
46
+ * const config: KeepTypenameConfig = {
47
+ * // Keep __typename for all JSON scalar variables
48
+ * JSON: KEEP,
49
+ *
50
+ * // For DashboardInput, only keep __typename on the config field
51
+ * DashboardInput: {
52
+ * config: KEEP,
53
+ * },
54
+ *
55
+ * // Nested configuration for complex input types
56
+ * UserInput: {
57
+ * profile: {
58
+ * settings: KEEP,
59
+ * },
60
+ * },
61
+ * };
62
+ * ```
63
+ */
4
64
  interface KeepTypenameConfig {
5
65
  [key: string]: typeof KEEP | RemoveTypenameFromVariablesLink.KeepTypenameConfig;
6
66
  }
67
+ /**
68
+ * Options for configuring the `RemoveTypenameFromVariablesLink`.
69
+ */
7
70
  interface Options {
71
+ /**
72
+ * Configuration that determines which input types should retain `__typename`
73
+ * fields.
74
+ *
75
+ * Maps GraphQL input type names to configurations. Each configuration can
76
+ * either be the `KEEP` sentinel, to preserve all `__typename` fields, or
77
+ * a nested object that specifies which fields should retain `__typename`.
78
+ *
79
+ * @example
80
+ *
81
+ * ```ts
82
+ * {
83
+ * except: {
84
+ * // Keep __typename for all JSON scalar variables
85
+ * JSON: KEEP,
86
+ *
87
+ * // For DashboardInput, remove __typename except for config field
88
+ * DashboardInput: {
89
+ * config: KEEP,
90
+ * },
91
+ *
92
+ * // Complex nested configuration
93
+ * UserProfileInput: {
94
+ * settings: {
95
+ * preferences: KEEP,
96
+ * },
97
+ * },
98
+ * },
99
+ * }
100
+ * ```
101
+ */
8
102
  except?: RemoveTypenameFromVariablesLink.KeepTypenameConfig;
9
103
  }
10
104
  }
@@ -13,6 +107,27 @@ export declare namespace RemoveTypenameFromVariablesLink {
13
107
  * Use `RemoveTypenameFromVariablesLink` from `@apollo/client/link/remove-typename` instead.
14
108
  */
15
109
  export declare function removeTypenameFromVariables(options?: RemoveTypenameFromVariablesLink.Options): RemoveTypenameFromVariablesLink;
110
+ /**
111
+ * `RemoveTypenameFromVariablesLink` is a non-terminating link that automatically
112
+ * removes `__typename` fields from operation variables to prevent GraphQL
113
+ * validation errors.
114
+ *
115
+ * @remarks
116
+ *
117
+ * When reusing data from a query as input to another GraphQL operation,
118
+ * `__typename` fields can cause server-side validation errors because input
119
+ * types don't accept fields that start with double underscores (`__`).
120
+ * `RemoveTypenameFromVariablesLink` automatically strips these fields from all
121
+ * operation variables.
122
+ *
123
+ * @example
124
+ *
125
+ * ```ts
126
+ * import { RemoveTypenameFromVariablesLink } from "@apollo/client/link/remove-typename";
127
+ *
128
+ * const link = new RemoveTypenameFromVariablesLink();
129
+ * ```
130
+ */
16
131
  export declare class RemoveTypenameFromVariablesLink extends ApolloLink {
17
132
  constructor(options?: RemoveTypenameFromVariablesLink.Options);
18
133
  }
@@ -6,9 +6,6 @@ const errors_1 = require("@apollo/client/errors");
6
6
  const link_1 = require("@apollo/client/link");
7
7
  const delayFunction_js_1 = require("./delayFunction.cjs");
8
8
  const retryFunction_js_1 = require("./retryFunction.cjs");
9
- /**
10
- * Tracking and management of operations that may be (or currently are) retried.
11
- */
12
9
  class RetryableOperation {
13
10
  observer;
14
11
  operation;
@@ -76,6 +73,31 @@ class RetryableOperation {
76
73
  }, delay);
77
74
  }
78
75
  }
76
+ /**
77
+ * `RetryLink` is a non-terminating link that attempts to retry operations that
78
+ * fail due to network errors. It enables resilient GraphQL operations by
79
+ * automatically retrying failed requests with configurable delay and retry
80
+ * strategies.
81
+ *
82
+ * @remarks
83
+ *
84
+ * `RetryLink` is particularly useful for handling unreliable network conditions
85
+ * where you would rather wait longer than explicitly fail an operation. It
86
+ * provides exponential backoff and jitters delays between attempts by default.
87
+ *
88
+ * > [!NOTE]
89
+ * > This link does not handle retries for GraphQL errors in the response. Use
90
+ * > `ErrorLink` to retry an operation after a GraphQL error. For more
91
+ * > information, see the [Error handling documentation](https://apollographql.com/docs/react/data/error-handling#on-graphql-errors).
92
+ *
93
+ * @example
94
+ *
95
+ * ```ts
96
+ * import { RetryLink } from "@apollo/client/link/retry";
97
+ *
98
+ * const link = new RetryLink();
99
+ * ```
100
+ */
79
101
  class RetryLink extends link_1.ApolloLink {
80
102
  delayFor;
81
103
  retryIf;
@@ -1 +1 @@
1
- {"version":3,"file":"retryLink.cjs","sources":["../../../../src/link/retry/retryLink.ts"],"sourcesContent":["import type { Subscription } from \"rxjs\";\nimport type { Observer } from \"rxjs\";\nimport { Observable } from \"rxjs\";\n\nimport type { ErrorLike } from \"@apollo/client\";\nimport {\n graphQLResultHasProtocolErrors,\n PROTOCOL_ERRORS_SYMBOL,\n toErrorLike,\n} from \"@apollo/client/errors\";\nimport { ApolloLink } from \"@apollo/client/link\";\n\nimport { buildDelayFunction } from \"./delayFunction.js\";\nimport { buildRetryFunction } from \"./retryFunction.js\";\n\nexport declare namespace RetryLink {\n export type DelayFunction = (\n count: number,\n operation: ApolloLink.Operation,\n error: ErrorLike\n ) => number;\n\n export interface DelayOptions {\n /**\n * The number of milliseconds to wait before attempting the first retry.\n *\n * Delays will increase exponentially for each attempt. E.g. if this is\n * set to 100, subsequent retries will be delayed by 200, 400, 800, etc,\n * until they reach maxDelay.\n *\n * Note that if jittering is enabled, this is the _average_ delay.\n *\n * @defaultValue `300`\n */\n initial?: number;\n\n /**\n * The maximum number of milliseconds that the link should wait for any\n * retry.\n *\n * @defaultValue `Infinity`\n */\n max?: number;\n\n /**\n * Whether delays between attempts should be randomized.\n *\n * This helps avoid thundering herd type situations by better distributing\n * load during major outages.\n *\n * @defaultValue `true`\n */\n jitter?: boolean;\n }\n\n export type AttemptsFunction = (\n count: number,\n operation: ApolloLink.Operation,\n error: ErrorLike\n ) => boolean | Promise<boolean>;\n\n export interface AttemptsOptions {\n /**\n * The max number of times to try a single operation before giving up. Pass\n * `Infinity` for infinite retries.\n *\n * Note that this INCLUDES the initial request as part of the count.\n * E.g. maxTries of 1 indicates no retrying should occur.\n *\n * @defaultValue `5`\n */\n max?: number;\n\n /**\n * Predicate function that determines whether a particular error should\n * trigger a retry.\n *\n * For example, you may want to not retry 4xx class HTTP errors.\n *\n * @defaultValue `() => true`\n */\n retryIf?: (\n error: ErrorLike,\n operation: ApolloLink.Operation\n ) => boolean | Promise<boolean>;\n }\n\n export interface Options {\n /**\n * Configuration for the delay strategy to use, or a custom delay strategy.\n */\n delay?: RetryLink.DelayOptions | RetryLink.DelayFunction;\n\n /**\n * Configuration for the retry strategy to use, or a custom retry strategy.\n */\n attempts?: RetryLink.AttemptsOptions | RetryLink.AttemptsFunction;\n }\n}\n\n/**\n * Tracking and management of operations that may be (or currently are) retried.\n */\nclass RetryableOperation {\n private retryCount: number = 0;\n private currentSubscription: Subscription | null = null;\n private timerId: ReturnType<typeof setTimeout> | undefined;\n\n constructor(\n private observer: Observer<ApolloLink.Result>,\n private operation: ApolloLink.Operation,\n private forward: ApolloLink.ForwardFunction,\n private delayFor: RetryLink.DelayFunction,\n private retryIf: RetryLink.AttemptsFunction\n ) {\n this.try();\n }\n\n /**\n * Stop retrying for the operation, and cancel any in-progress requests.\n */\n public cancel() {\n if (this.currentSubscription) {\n this.currentSubscription.unsubscribe();\n }\n clearTimeout(this.timerId);\n this.timerId = undefined;\n this.currentSubscription = null;\n }\n\n private try() {\n this.currentSubscription = this.forward(this.operation).subscribe({\n next: (result) => {\n if (graphQLResultHasProtocolErrors(result)) {\n this.onError(result.extensions[PROTOCOL_ERRORS_SYMBOL], () =>\n // Pretend like we never encountered this error and move the result\n // along for Apollo Client core to handle this error.\n this.observer.next(result)\n );\n // Unsubscribe from the current subscription to prevent the `complete`\n // handler to be called as a result of the stream closing.\n this.currentSubscription?.unsubscribe();\n return;\n }\n\n this.observer.next(result);\n },\n error: (error) => this.onError(error, () => this.observer.error(error)),\n complete: this.observer.complete.bind(this.observer),\n });\n }\n\n private onError = async (error: unknown, onContinue: () => void) => {\n this.retryCount += 1;\n const errorLike = toErrorLike(error);\n\n const shouldRetry = await this.retryIf(\n this.retryCount,\n this.operation,\n errorLike\n );\n if (shouldRetry) {\n this.scheduleRetry(\n this.delayFor(this.retryCount, this.operation, errorLike)\n );\n return;\n }\n\n onContinue();\n };\n\n private scheduleRetry(delay: number) {\n if (this.timerId) {\n throw new Error(`RetryLink BUG! Encountered overlapping retries`);\n }\n\n this.timerId = setTimeout(() => {\n this.timerId = undefined;\n this.try();\n }, delay);\n }\n}\n\nexport class RetryLink extends ApolloLink {\n private delayFor: RetryLink.DelayFunction;\n private retryIf: RetryLink.AttemptsFunction;\n\n constructor(options?: RetryLink.Options) {\n super();\n const { attempts, delay } = options || ({} as RetryLink.Options);\n this.delayFor =\n typeof delay === \"function\" ? delay : buildDelayFunction(delay);\n this.retryIf =\n typeof attempts === \"function\" ? attempts : buildRetryFunction(attempts);\n }\n\n public request(\n operation: ApolloLink.Operation,\n forward: ApolloLink.ForwardFunction\n ): Observable<ApolloLink.Result> {\n return new Observable((observer) => {\n const retryable = new RetryableOperation(\n observer,\n operation,\n forward,\n this.delayFor,\n this.retryIf\n );\n return () => {\n retryable.cancel();\n };\n });\n }\n}\n"],"names":[],"mappings":";;;AAEA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAGA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAKA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAEA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,sBAAA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,sBAAA,CAAA;AAuFA,CAAA,CAAA;;CAEA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,EAAM,CAAN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA;IAMY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;IACY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;IACY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;IACY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;IACY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;IATU,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAA+B,CAAC;IACtB,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAqD,CAArD,CAAA,CAAA,CAAyD;IAC/C,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiB;IAEf,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACY,CADZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACiD,EACrC,CAFZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAE2C,EAC/B,CAHZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAG+C,EACnC,CAJZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAI6C,EACjC,CALZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAK+C,EAL/C;QACY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB;QACR,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqB;QACT,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAmB;QACP,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB;QACR,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAmB;QAEf,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAY,CAAZ,CAAc;IACZ;IAEA,CAAF,CAAA;;KAEA,CAAA;IACS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAe,CAAf,EAAA;QACI,CAAJ,EAAA,CAAQ,CAAR,CAAA,CAAA,CAAY,CAAC,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgC,EAAE;YAC5B,CAAN,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8B,CAAC,CAA/B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0C,CAA1C,CAA4C;QACxC;QACA,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgB,CAAC,CAAjB,CAAA,CAAA,CAAqB,CAAC,CAAtB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,CAAC;QAC1B,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAmB,CAAnB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA4B;QACxB,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAA+B,CAA/B,CAAA,CAAA,CAAmC;IACjC;IAEQ,CAAV,CAAA,CAAa,CAAb,EAAA;QACI,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAA+B,CAA/B,CAAA,CAAA,CAAmC,CAAC,CAApC,CAAA,CAAA,CAAA,CAAA,CAAA,CAA2C,CAAC,CAA5C,CAAA,CAAA,CAAgD,CAAC,CAAjD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0D,CAAC,CAAC,CAA5D,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqE,CAAC;YAChE,CAAN,CAAA,CAAA,CAAU,EAAE,CAAC,CAAb,CAAA,CAAA,CAAA,CAAA,CAAmB,EAAE,CAArB,EAAA;gBACQ,CAAR,EAAA,CAAY,CAAZ,CAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0C,CAA1C,CAA2C,CAA3C,CAAA,CAAA,CAAA,CAAA,CAAiD,CAAC,EAAE;oBAC1C,CAAV,CAAA,CAAA,CAAc,CAAC,CAAf,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsB,CAAC,CAAvB,CAAA,CAAA,CAAA,CAAA,CAA6B,CAAC,CAA9B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwC,CAAC,CAAzC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA+D,CAAC,EAAE,CAAlE,EAAqE,CAArE;oBACY,CAAZ,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA;oBACY,CAAZ,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA;oBACY,CAAZ,CAAA,CAAA,CAAgB,CAAC,CAAjB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAC,CAA1B,CAAA,CAAA,CAA8B,CAAC,CAA/B,CAAA,CAAA,CAAA,CAAA,CAAqC,CAAC,CAC3B;oBACD,CAAV,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;oBACU,CAAV,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;oBACU,CAAV,CAAA,CAAA,CAAc,CAAC,CAAf,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkC,CAAlC,CAAoC,CAApC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA+C,CAA/C,CAAiD;oBACvC,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA;gBACQ;gBAEA,CAAR,CAAA,CAAA,CAAY,CAAC,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqB,CAAC,CAAtB,CAAA,CAAA,CAA0B,CAAC,CAA3B,CAAA,CAAA,CAAA,CAAA,CAAiC,CAAC;YAC5B,CAAC;YACD,CAAN,CAAA,CAAA,CAAA,CAAW,EAAE,CAAC,CAAd,CAAA,CAAA,CAAA,CAAmB,EAAE,CAArB,EAAwB,CAAxB,CAAA,CAAA,CAA4B,CAAC,CAA7B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoC,CAAC,CAArC,CAAA,CAAA,CAAA,CAA0C,EAAE,CAA5C,EAA+C,CAA/C,EAAkD,CAAlD,CAAA,CAAA,CAAsD,CAAC,CAAvD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA+D,CAAC,CAAhE,CAAA,CAAA,CAAA,CAAqE,CAAC,CAAtE,CAAA,CAAA,CAAA,CAA2E,CAAC,CAAC;YACvE,CAAN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAc,EAAE,CAAhB,CAAA,CAAA,CAAoB,CAAC,CAArB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,CAAC,CAA9B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsC,CAAC,CAAvC,CAAA,CAAA,CAA2C,CAAC,CAA5C,CAAA,CAAA,CAAgD,CAAC,CAAjD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyD,CAAC;QAC1D,CAAK,CAAC;IACJ;IAEQ,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAoB,CAApB,CAAA,CAAA,CAAA,EAAA,CAA2B,CAA3B,CAAA,CAAA,CAAA,CAAyC,EAAE,CAA3C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiE,EAAE,CAAnE,EAAA;QACI,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAuB,CAAC;QACpB,CAAJ,CAAA,CAAA,CAAA,EAAU,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAsB,CAAtB,CAAA,EAAsB,CAAtB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiC,CAAjC,CAAkC,CAAlC,CAAA,CAAA,CAAA,CAAuC,CAAC;QAEpC,CAAJ,CAAA,CAAA,CAAA,EAAU,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAwB,CAAxB,CAAA,CAAA,CAAA,EAA8B,CAA9B,CAAA,CAAA,CAAkC,CAAC,CAAnC,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0C,CACpC,CADN,CAAA,CAAA,CACU,CAAC,CADX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACqB,EACf,CAFN,CAAA,CAAA,CAEU,CAAC,CAFX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAEoB,EACd,CAHN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAGe,CACV;QACD,CAAJ,EAAA,CAAQ,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAmB,EAAE;YACf,CAAN,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwB,CAChB,CADR,CAAA,CAAA,CACY,CAAC,CADb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACqB,CAAC,CADtB,CAAA,CAAA,CAC0B,CAAC,CAD3B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACqC,EAAE,CADvC,CAAA,CAAA,CAC2C,CAAC,CAD5C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACqD,EAAE,CADvD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACgE,CAAC,CAC1D;YACD,CAAN,CAAA,CAAA,CAAA,CAAA,CAAA;QACI;QAEA,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAc,CAAd,CAAgB;IACd,CAAC;IAEO,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuB,CAAC,CAAxB,CAAA,CAAA,CAAA,CAAqC,EAArC;QACI,CAAJ,EAAA,CAAQ,CAAR,CAAA,CAAA,CAAY,CAAC,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,EAAE;YAChB,CAAN,CAAA,CAAA,CAAA,EAAY,CAAZ,CAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAqB,CAAC,CAAtB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsE,CAAC;QACnE;QAEA,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAmB,CAAnB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,CAAC,CAA9B,EAAiC,CAAjC,EAAA;YACM,CAAN,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAqB,CAArB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8B;YACxB,CAAN,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAc,CAAd,CAAgB;QACZ,CAAC,EAAE,CAAP,CAAA,CAAA,CAAA,CAAY,CAAC;IACX;AACF;AAEA,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAA+B,CAA/B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA;IACU,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkB;IACR,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiB;IAEf,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAc,CAAd,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyC,EAAzC;QACI,CAAJ,CAAA,CAAA,CAAA,CAAS,CAAT,CAAW;QACP,CAAJ,CAAA,CAAA,CAAA,EAAU,EAAE,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,EAAE,CAAtB,CAAA,CAAA,CAAA,EAAA,EAAA,EAAgC,CAAhC,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAA4C,CAA5C,CAAoE;QAChE,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA;YACM,CAAN,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAuB,CAAvB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAkC,EAAE,CAApC,CAAA,CAAA,CAAA,EAA0C,EAAE,CAA5C,CAAA,EAA4C,CAA5C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8D,CAA9D,CAA+D,CAA/D,CAAA,CAAA,CAAA,CAAoE,CAAC;QACjE,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA;YACM,CAAN,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAA0B,CAA1B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAqC,EAAE,CAAvC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAgD,EAAE,CAAlD,CAAA,EAAkD,CAAlD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoE,CAApE,CAAqE,CAArE,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6E,CAAC;IAC5E;IAEO,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgB,CACZ,CADJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACmC,EAC/B,CAFJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAEuC,EAFvC;QAII,CAAJ,CAAA,CAAA,CAAA,CAAA,EAAW,CAAX,CAAA,EAAe,CAAf,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAC,CAAC,CAA3B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAmC,EAAE,CAArC,EAAA;YACM,CAAN,CAAA,CAAA,CAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAwB,CAAxB,CAAA,EAA4B,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8C,CACtC,CADR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACgB,EACR,CAFR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAEiB,EACT,CAHR,CAAA,CAAA,CAAA,CAAA,CAAA,CAGe,EACP,CAJR,CAAA,CAAA,CAIY,CAAC,CAJb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAIqB,EACb,CALR,CAAA,CAAA,CAKY,CAAC,CALb,CAAA,CAAA,CAAA,CAAA,CAAA,CAKoB,CACb;YACD,CAAN,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,EAAgB,CAAhB,EAAA;gBACQ,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiB,CAAC,CAAlB,CAAA,CAAA,CAAA,CAAA,CAAwB,CAAxB,CAA0B;YACpB,CAAC;QACH,CAAC,CAAC;IACJ;AACF;AA9BA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;"}
1
+ {"version":3,"file":"retryLink.cjs","sources":["../../../../src/link/retry/retryLink.ts"],"sourcesContent":["import type { Subscription } from \"rxjs\";\nimport type { Observer } from \"rxjs\";\nimport { Observable } from \"rxjs\";\n\nimport type { ErrorLike } from \"@apollo/client\";\nimport {\n graphQLResultHasProtocolErrors,\n PROTOCOL_ERRORS_SYMBOL,\n toErrorLike,\n} from \"@apollo/client/errors\";\nimport { ApolloLink } from \"@apollo/client/link\";\n\nimport { buildDelayFunction } from \"./delayFunction.js\";\nimport { buildRetryFunction } from \"./retryFunction.js\";\n\nexport declare namespace RetryLink {\n namespace RetryLinkDocumentationTypes {\n /**\n * A function used to determine whether to retry the current operation.\n *\n * @param attempt - The current attempt number\n * @param operation - The current `ApolloLink.Operation` for the request\n * @param error - The error that triggered the retry attempt\n * @returns A boolean to indicate whether to retry the current operation\n */\n function AttemptsFunction(\n attempt: number,\n operation: ApolloLink.Operation,\n error: ErrorLike\n ): boolean | Promise<boolean>;\n\n /**\n * A function used to determine the delay for a retry attempt.\n *\n * @param attempt - The current attempt number\n * @param operation - The current `ApolloLink.Operation` for the request\n * @param error - The error that triggered the retry attempt\n * @returns The delay in milliseconds before attempting the request again\n */\n function DelayFunction(\n attempt: number,\n operation: ApolloLink.Operation,\n error: ErrorLike\n ): number;\n }\n\n /** {@inheritDoc @apollo/client/link/retry!RetryLink.RetryLinkDocumentationTypes.DelayFunction:function(1)} */\n export type DelayFunction = (\n attempt: number,\n operation: ApolloLink.Operation,\n error: ErrorLike\n ) => number;\n\n /**\n * Configuration options for the standard retry delay strategy.\n */\n export interface DelayOptions {\n /**\n * The number of milliseconds to wait before attempting the first retry.\n *\n * Delays will increase exponentially for each attempt. E.g. if this is\n * set to 100, subsequent retries will be delayed by 200, 400, 800, etc,\n * until they reach the maximum delay.\n *\n * Note that if jittering is enabled, this is the average delay.\n *\n * @defaultValue `300`\n */\n initial?: number;\n\n /**\n * The maximum number of milliseconds that the link should wait for any\n * retry.\n *\n * @defaultValue `Infinity`\n */\n max?: number;\n\n /**\n * Whether delays between attempts should be randomized.\n *\n * This helps avoid [thundering herd](https://en.wikipedia.org/wiki/Thundering_herd_problem)\n * type situations by better distributing load during major outages. Without\n * these strategies, when your server comes back up it will be hit by all\n * of your clients at once, possibly causing it to go down again.\n *\n * @defaultValue `true`\n */\n jitter?: boolean;\n }\n\n /** {@inheritDoc @apollo/client/link/retry!RetryLink.RetryLinkDocumentationTypes.AttemptsFunction:function(1)} */\n export type AttemptsFunction = (\n attempt: number,\n operation: ApolloLink.Operation,\n error: ErrorLike\n ) => boolean | Promise<boolean>;\n\n /**\n * Configuration options for the standard retry attempt strategy.\n */\n export interface AttemptsOptions {\n /**\n * The max number of times to try a single operation before giving up.\n *\n * Note that this INCLUDES the initial request as part of the count.\n * E.g. `max` of 1 indicates no retrying should occur.\n *\n * Pass `Infinity` for infinite retries.\n *\n * @defaultValue `5`\n */\n max?: number;\n\n /**\n * Predicate function that determines whether a particular error should\n * trigger a retry.\n *\n * For example, you may want to not retry 4xx class HTTP errors.\n *\n * @defaultValue `() => true`\n */\n retryIf?: (\n error: ErrorLike,\n operation: ApolloLink.Operation\n ) => boolean | Promise<boolean>;\n }\n\n /**\n * Options provided to the `RetryLink` constructor.\n */\n export interface Options {\n /**\n * Configuration for the delay strategy to use, or a custom delay strategy.\n */\n delay?: RetryLink.DelayOptions | RetryLink.DelayFunction;\n\n /**\n * Configuration for the retry strategy to use, or a custom retry strategy.\n */\n attempts?: RetryLink.AttemptsOptions | RetryLink.AttemptsFunction;\n }\n}\n\nclass RetryableOperation {\n private retryCount: number = 0;\n private currentSubscription: Subscription | null = null;\n private timerId: ReturnType<typeof setTimeout> | undefined;\n\n constructor(\n private observer: Observer<ApolloLink.Result>,\n private operation: ApolloLink.Operation,\n private forward: ApolloLink.ForwardFunction,\n private delayFor: RetryLink.DelayFunction,\n private retryIf: RetryLink.AttemptsFunction\n ) {\n this.try();\n }\n\n /**\n * Stop retrying for the operation, and cancel any in-progress requests.\n */\n public cancel() {\n if (this.currentSubscription) {\n this.currentSubscription.unsubscribe();\n }\n clearTimeout(this.timerId);\n this.timerId = undefined;\n this.currentSubscription = null;\n }\n\n private try() {\n this.currentSubscription = this.forward(this.operation).subscribe({\n next: (result) => {\n if (graphQLResultHasProtocolErrors(result)) {\n this.onError(result.extensions[PROTOCOL_ERRORS_SYMBOL], () =>\n // Pretend like we never encountered this error and move the result\n // along for Apollo Client core to handle this error.\n this.observer.next(result)\n );\n // Unsubscribe from the current subscription to prevent the `complete`\n // handler to be called as a result of the stream closing.\n this.currentSubscription?.unsubscribe();\n return;\n }\n\n this.observer.next(result);\n },\n error: (error) => this.onError(error, () => this.observer.error(error)),\n complete: this.observer.complete.bind(this.observer),\n });\n }\n\n private onError = async (error: unknown, onContinue: () => void) => {\n this.retryCount += 1;\n const errorLike = toErrorLike(error);\n\n const shouldRetry = await this.retryIf(\n this.retryCount,\n this.operation,\n errorLike\n );\n if (shouldRetry) {\n this.scheduleRetry(\n this.delayFor(this.retryCount, this.operation, errorLike)\n );\n return;\n }\n\n onContinue();\n };\n\n private scheduleRetry(delay: number) {\n if (this.timerId) {\n throw new Error(`RetryLink BUG! Encountered overlapping retries`);\n }\n\n this.timerId = setTimeout(() => {\n this.timerId = undefined;\n this.try();\n }, delay);\n }\n}\n\n/**\n * `RetryLink` is a non-terminating link that attempts to retry operations that\n * fail due to network errors. It enables resilient GraphQL operations by\n * automatically retrying failed requests with configurable delay and retry\n * strategies.\n *\n * @remarks\n *\n * `RetryLink` is particularly useful for handling unreliable network conditions\n * where you would rather wait longer than explicitly fail an operation. It\n * provides exponential backoff and jitters delays between attempts by default.\n *\n * > [!NOTE]\n * > This link does not handle retries for GraphQL errors in the response. Use\n * > `ErrorLink` to retry an operation after a GraphQL error. For more\n * > information, see the [Error handling documentation](https://apollographql.com/docs/react/data/error-handling#on-graphql-errors).\n *\n * @example\n *\n * ```ts\n * import { RetryLink } from \"@apollo/client/link/retry\";\n *\n * const link = new RetryLink();\n * ```\n */\nexport class RetryLink extends ApolloLink {\n private delayFor: RetryLink.DelayFunction;\n private retryIf: RetryLink.AttemptsFunction;\n\n constructor(options?: RetryLink.Options) {\n super();\n const { attempts, delay } = options || ({} as RetryLink.Options);\n this.delayFor =\n typeof delay === \"function\" ? delay : buildDelayFunction(delay);\n this.retryIf =\n typeof attempts === \"function\" ? attempts : buildRetryFunction(attempts);\n }\n\n public request(\n operation: ApolloLink.Operation,\n forward: ApolloLink.ForwardFunction\n ): Observable<ApolloLink.Result> {\n return new Observable((observer) => {\n const retryable = new RetryableOperation(\n observer,\n operation,\n forward,\n this.delayFor,\n this.retryIf\n );\n return () => {\n retryable.cancel();\n };\n });\n }\n}\n"],"names":[],"mappings":";;;AAEA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAGA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAKA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAEA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,sBAAA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,sBAAA,CAAA;AAmIA,CAAA,CAAA,CAAA,CAAA,EAAM,CAAN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA;IAMY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;IACY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;IACY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;IACY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;IACY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;IATU,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAA+B,CAAC;IACtB,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAqD,CAArD,CAAA,CAAA,CAAyD;IAC/C,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiB;IAEf,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACY,CADZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACiD,EACrC,CAFZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAE2C,EAC/B,CAHZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAG+C,EACnC,CAJZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAI6C,EACjC,CALZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAK+C,EAL/C;QACY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB;QACR,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqB;QACT,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAmB;QACP,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB;QACR,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAmB;QAEf,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAY,CAAZ,CAAc;IACZ;IAEA,CAAF,CAAA;;KAEA,CAAA;IACS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAe,CAAf,EAAA;QACI,CAAJ,EAAA,CAAQ,CAAR,CAAA,CAAA,CAAY,CAAC,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgC,EAAE;YAC5B,CAAN,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8B,CAAC,CAA/B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0C,CAA1C,CAA4C;QACxC;QACA,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgB,CAAC,CAAjB,CAAA,CAAA,CAAqB,CAAC,CAAtB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,CAAC;QAC1B,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAmB,CAAnB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA4B;QACxB,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAA+B,CAA/B,CAAA,CAAA,CAAmC;IACjC;IAEQ,CAAV,CAAA,CAAa,CAAb,EAAA;QACI,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAA+B,CAA/B,CAAA,CAAA,CAAmC,CAAC,CAApC,CAAA,CAAA,CAAA,CAAA,CAAA,CAA2C,CAAC,CAA5C,CAAA,CAAA,CAAgD,CAAC,CAAjD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0D,CAAC,CAAC,CAA5D,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqE,CAAC;YAChE,CAAN,CAAA,CAAA,CAAU,EAAE,CAAC,CAAb,CAAA,CAAA,CAAA,CAAA,CAAmB,EAAE,CAArB,EAAA;gBACQ,CAAR,EAAA,CAAY,CAAZ,CAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0C,CAA1C,CAA2C,CAA3C,CAAA,CAAA,CAAA,CAAA,CAAiD,CAAC,EAAE;oBAC1C,CAAV,CAAA,CAAA,CAAc,CAAC,CAAf,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsB,CAAC,CAAvB,CAAA,CAAA,CAAA,CAAA,CAA6B,CAAC,CAA9B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwC,CAAC,CAAzC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA+D,CAAC,EAAE,CAAlE,EAAqE,CAArE;oBACY,CAAZ,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA;oBACY,CAAZ,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA;oBACY,CAAZ,CAAA,CAAA,CAAgB,CAAC,CAAjB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAC,CAA1B,CAAA,CAAA,CAA8B,CAAC,CAA/B,CAAA,CAAA,CAAA,CAAA,CAAqC,CAAC,CAC3B;oBACD,CAAV,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;oBACU,CAAV,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;oBACU,CAAV,CAAA,CAAA,CAAc,CAAC,CAAf,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkC,CAAlC,CAAoC,CAApC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA+C,CAA/C,CAAiD;oBACvC,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA;gBACQ;gBAEA,CAAR,CAAA,CAAA,CAAY,CAAC,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqB,CAAC,CAAtB,CAAA,CAAA,CAA0B,CAAC,CAA3B,CAAA,CAAA,CAAA,CAAA,CAAiC,CAAC;YAC5B,CAAC;YACD,CAAN,CAAA,CAAA,CAAA,CAAW,EAAE,CAAC,CAAd,CAAA,CAAA,CAAA,CAAmB,EAAE,CAArB,EAAwB,CAAxB,CAAA,CAAA,CAA4B,CAAC,CAA7B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoC,CAAC,CAArC,CAAA,CAAA,CAAA,CAA0C,EAAE,CAA5C,EAA+C,CAA/C,EAAkD,CAAlD,CAAA,CAAA,CAAsD,CAAC,CAAvD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA+D,CAAC,CAAhE,CAAA,CAAA,CAAA,CAAqE,CAAC,CAAtE,CAAA,CAAA,CAAA,CAA2E,CAAC,CAAC;YACvE,CAAN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAc,EAAE,CAAhB,CAAA,CAAA,CAAoB,CAAC,CAArB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,CAAC,CAA9B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsC,CAAC,CAAvC,CAAA,CAAA,CAA2C,CAAC,CAA5C,CAAA,CAAA,CAAgD,CAAC,CAAjD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyD,CAAC;QAC1D,CAAK,CAAC;IACJ;IAEQ,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAoB,CAApB,CAAA,CAAA,CAAA,EAAA,CAA2B,CAA3B,CAAA,CAAA,CAAA,CAAyC,EAAE,CAA3C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiE,EAAE,CAAnE,EAAA;QACI,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAuB,CAAC;QACpB,CAAJ,CAAA,CAAA,CAAA,EAAU,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAsB,CAAtB,CAAA,EAAsB,CAAtB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiC,CAAjC,CAAkC,CAAlC,CAAA,CAAA,CAAA,CAAuC,CAAC;QAEpC,CAAJ,CAAA,CAAA,CAAA,EAAU,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAwB,CAAxB,CAAA,CAAA,CAAA,EAA8B,CAA9B,CAAA,CAAA,CAAkC,CAAC,CAAnC,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0C,CACpC,CADN,CAAA,CAAA,CACU,CAAC,CADX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACqB,EACf,CAFN,CAAA,CAAA,CAEU,CAAC,CAFX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAEoB,EACd,CAHN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAGe,CACV;QACD,CAAJ,EAAA,CAAQ,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAmB,EAAE;YACf,CAAN,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwB,CAChB,CADR,CAAA,CAAA,CACY,CAAC,CADb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACqB,CAAC,CADtB,CAAA,CAAA,CAC0B,CAAC,CAD3B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACqC,EAAE,CADvC,CAAA,CAAA,CAC2C,CAAC,CAD5C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACqD,EAAE,CADvD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACgE,CAAC,CAC1D;YACD,CAAN,CAAA,CAAA,CAAA,CAAA,CAAA;QACI;QAEA,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAc,CAAd,CAAgB;IACd,CAAC;IAEO,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuB,CAAC,CAAxB,CAAA,CAAA,CAAA,CAAqC,EAArC;QACI,CAAJ,EAAA,CAAQ,CAAR,CAAA,CAAA,CAAY,CAAC,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,EAAE;YAChB,CAAN,CAAA,CAAA,CAAA,EAAY,CAAZ,CAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAqB,CAAC,CAAtB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsE,CAAC;QACnE;QAEA,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAmB,CAAnB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,CAAC,CAA9B,EAAiC,CAAjC,EAAA;YACM,CAAN,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAqB,CAArB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8B;YACxB,CAAN,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAc,CAAd,CAAgB;QACZ,CAAC,EAAE,CAAP,CAAA,CAAA,CAAA,CAAY,CAAC;IACX;AACF;AAEA,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;CAwBA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAA+B,CAA/B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA;IACU,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkB;IACR,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiB;IAEf,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAc,CAAd,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyC,EAAzC;QACI,CAAJ,CAAA,CAAA,CAAA,CAAS,CAAT,CAAW;QACP,CAAJ,CAAA,CAAA,CAAA,EAAU,EAAE,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,EAAE,CAAtB,CAAA,CAAA,CAAA,EAAA,EAAA,EAAgC,CAAhC,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAA4C,CAA5C,CAAoE;QAChE,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA;YACM,CAAN,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAuB,CAAvB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAkC,EAAE,CAApC,CAAA,CAAA,CAAA,EAA0C,EAAE,CAA5C,CAAA,EAA4C,CAA5C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8D,CAA9D,CAA+D,CAA/D,CAAA,CAAA,CAAA,CAAoE,CAAC;QACjE,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA;YACM,CAAN,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAA0B,CAA1B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAqC,EAAE,CAAvC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAgD,EAAE,CAAlD,CAAA,EAAkD,CAAlD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoE,CAApE,CAAqE,CAArE,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6E,CAAC;IAC5E;IAEO,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgB,CACZ,CADJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACmC,EAC/B,CAFJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAEuC,EAFvC;QAII,CAAJ,CAAA,CAAA,CAAA,CAAA,EAAW,CAAX,CAAA,EAAe,CAAf,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAC,CAAC,CAA3B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAmC,EAAE,CAArC,EAAA;YACM,CAAN,CAAA,CAAA,CAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAwB,CAAxB,CAAA,EAA4B,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8C,CACtC,CADR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACgB,EACR,CAFR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAEiB,EACT,CAHR,CAAA,CAAA,CAAA,CAAA,CAAA,CAGe,EACP,CAJR,CAAA,CAAA,CAIY,CAAC,CAJb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAIqB,EACb,CALR,CAAA,CAAA,CAKY,CAAC,CALb,CAAA,CAAA,CAAA,CAAA,CAAA,CAKoB,CACb;YACD,CAAN,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,EAAgB,CAAhB,EAAA;gBACQ,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiB,CAAC,CAAlB,CAAA,CAAA,CAAA,CAAA,CAAwB,CAAxB,CAA0B;YACpB,CAAC;QACH,CAAC,CAAC;IACJ;AACF;AA9BA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;"}
@@ -2,16 +2,47 @@ import { Observable } from "rxjs";
2
2
  import type { ErrorLike } from "@apollo/client";
3
3
  import { ApolloLink } from "@apollo/client/link";
4
4
  export declare namespace RetryLink {
5
- type DelayFunction = (count: number, operation: ApolloLink.Operation, error: ErrorLike) => number;
5
+ namespace RetryLinkDocumentationTypes {
6
+ /**
7
+ * A function used to determine whether to retry the current operation.
8
+ *
9
+ * @param attempt - The current attempt number
10
+ * @param operation - The current `ApolloLink.Operation` for the request
11
+ * @param error - The error that triggered the retry attempt
12
+ * @returns A boolean to indicate whether to retry the current operation
13
+ */
14
+ function AttemptsFunction(attempt: number, operation: ApolloLink.Operation, error: ErrorLike): boolean | Promise<boolean>;
15
+ /**
16
+ * A function used to determine the delay for a retry attempt.
17
+ *
18
+ * @param attempt - The current attempt number
19
+ * @param operation - The current `ApolloLink.Operation` for the request
20
+ * @param error - The error that triggered the retry attempt
21
+ * @returns The delay in milliseconds before attempting the request again
22
+ */
23
+ function DelayFunction(attempt: number, operation: ApolloLink.Operation, error: ErrorLike): number;
24
+ }
25
+ /**
26
+ * A function used to determine the delay for a retry attempt.
27
+ *
28
+ * @param attempt - The current attempt number
29
+ * @param operation - The current `ApolloLink.Operation` for the request
30
+ * @param error - The error that triggered the retry attempt
31
+ * @returns The delay in milliseconds before attempting the request again
32
+ */
33
+ type DelayFunction = (attempt: number, operation: ApolloLink.Operation, error: ErrorLike) => number;
34
+ /**
35
+ * Configuration options for the standard retry delay strategy.
36
+ */
6
37
  interface DelayOptions {
7
38
  /**
8
39
  * The number of milliseconds to wait before attempting the first retry.
9
40
  *
10
41
  * Delays will increase exponentially for each attempt. E.g. if this is
11
42
  * set to 100, subsequent retries will be delayed by 200, 400, 800, etc,
12
- * until they reach maxDelay.
43
+ * until they reach the maximum delay.
13
44
  *
14
- * Note that if jittering is enabled, this is the _average_ delay.
45
+ * Note that if jittering is enabled, this is the average delay.
15
46
  *
16
47
  * @defaultValue `300`
17
48
  */
@@ -26,21 +57,35 @@ export declare namespace RetryLink {
26
57
  /**
27
58
  * Whether delays between attempts should be randomized.
28
59
  *
29
- * This helps avoid thundering herd type situations by better distributing
30
- * load during major outages.
60
+ * This helps avoid [thundering herd](https://en.wikipedia.org/wiki/Thundering_herd_problem)
61
+ * type situations by better distributing load during major outages. Without
62
+ * these strategies, when your server comes back up it will be hit by all
63
+ * of your clients at once, possibly causing it to go down again.
31
64
  *
32
65
  * @defaultValue `true`
33
66
  */
34
67
  jitter?: boolean;
35
68
  }
36
- type AttemptsFunction = (count: number, operation: ApolloLink.Operation, error: ErrorLike) => boolean | Promise<boolean>;
69
+ /**
70
+ * A function used to determine whether to retry the current operation.
71
+ *
72
+ * @param attempt - The current attempt number
73
+ * @param operation - The current `ApolloLink.Operation` for the request
74
+ * @param error - The error that triggered the retry attempt
75
+ * @returns A boolean to indicate whether to retry the current operation
76
+ */
77
+ type AttemptsFunction = (attempt: number, operation: ApolloLink.Operation, error: ErrorLike) => boolean | Promise<boolean>;
78
+ /**
79
+ * Configuration options for the standard retry attempt strategy.
80
+ */
37
81
  interface AttemptsOptions {
38
82
  /**
39
- * The max number of times to try a single operation before giving up. Pass
40
- * `Infinity` for infinite retries.
83
+ * The max number of times to try a single operation before giving up.
41
84
  *
42
85
  * Note that this INCLUDES the initial request as part of the count.
43
- * E.g. maxTries of 1 indicates no retrying should occur.
86
+ * E.g. `max` of 1 indicates no retrying should occur.
87
+ *
88
+ * Pass `Infinity` for infinite retries.
44
89
  *
45
90
  * @defaultValue `5`
46
91
  */
@@ -55,6 +100,9 @@ export declare namespace RetryLink {
55
100
  */
56
101
  retryIf?: (error: ErrorLike, operation: ApolloLink.Operation) => boolean | Promise<boolean>;
57
102
  }
103
+ /**
104
+ * Options provided to the `RetryLink` constructor.
105
+ */
58
106
  interface Options {
59
107
  /**
60
108
  * Configuration for the delay strategy to use, or a custom delay strategy.
@@ -66,6 +114,31 @@ export declare namespace RetryLink {
66
114
  attempts?: RetryLink.AttemptsOptions | RetryLink.AttemptsFunction;
67
115
  }
68
116
  }
117
+ /**
118
+ * `RetryLink` is a non-terminating link that attempts to retry operations that
119
+ * fail due to network errors. It enables resilient GraphQL operations by
120
+ * automatically retrying failed requests with configurable delay and retry
121
+ * strategies.
122
+ *
123
+ * @remarks
124
+ *
125
+ * `RetryLink` is particularly useful for handling unreliable network conditions
126
+ * where you would rather wait longer than explicitly fail an operation. It
127
+ * provides exponential backoff and jitters delays between attempts by default.
128
+ *
129
+ * > [!NOTE]
130
+ * > This link does not handle retries for GraphQL errors in the response. Use
131
+ * > `ErrorLink` to retry an operation after a GraphQL error. For more
132
+ * > information, see the [Error handling documentation](https://apollographql.com/docs/react/data/error-handling#on-graphql-errors).
133
+ *
134
+ * @example
135
+ *
136
+ * ```ts
137
+ * import { RetryLink } from "@apollo/client/link/retry";
138
+ *
139
+ * const link = new RetryLink();
140
+ * ```
141
+ */
69
142
  export declare class RetryLink extends ApolloLink {
70
143
  private delayFor;
71
144
  private retryIf;
@@ -4,6 +4,26 @@ exports.SchemaLink = void 0;
4
4
  const graphql_1 = require("graphql");
5
5
  const rxjs_1 = require("rxjs");
6
6
  const link_1 = require("@apollo/client/link");
7
+ /**
8
+ * `SchemaLink` is a terminating link that executes GraphQL operations against
9
+ * a local GraphQL schema instead of making network requests. This is commonly
10
+ * used for server-side rendering (SSR) and mocking dataa.
11
+ *
12
+ * > [!NOTE]
13
+ * > While `SchemaLink` can provide GraphQL results on the client, the GraphQL
14
+ * > execution layer is [quite large](https://bundlephobia.com/result?p=graphql) for practical client-side use.
15
+ * > For client-side state management, consider Apollo Client's [local state management](https://apollographql.com/docs/react/local-state/local-state-management/)
16
+ * > functionality instead, which integrates with the Apollo Client cache.
17
+ *
18
+ * @example
19
+ *
20
+ * ```ts
21
+ * import { SchemaLink } from "@apollo/client/link/schema";
22
+ * import schema from "./path/to/your/schema";
23
+ *
24
+ * const link = new SchemaLink({ schema });
25
+ * ```
26
+ */
7
27
  class SchemaLink extends link_1.ApolloLink {
8
28
  schema;
9
29
  rootValue;
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs","sources":["../../../../src/link/schema/index.ts"],"sourcesContent":["import type { GraphQLSchema } from \"graphql\";\nimport { execute, validate } from \"graphql\";\nimport { Observable } from \"rxjs\";\n\nimport { ApolloLink } from \"@apollo/client/link\";\n\nexport declare namespace SchemaLink {\n export type ResolverContext = Record<string, any>;\n export type ResolverContextFunction = (\n operation: ApolloLink.Operation\n ) => ResolverContext | PromiseLike<ResolverContext>;\n\n export interface Options {\n /**\n * The schema to generate responses from.\n */\n schema: GraphQLSchema;\n\n /**\n * The root value to use when generating responses.\n */\n rootValue?: any;\n\n /**\n * A context to provide to resolvers declared within the schema.\n */\n context?: SchemaLink.ResolverContext | SchemaLink.ResolverContextFunction;\n\n /**\n * Validate incoming queries against the given schema, returning\n * validation errors as a GraphQL server would.\n */\n validate?: boolean;\n }\n}\n\nexport class SchemaLink extends ApolloLink {\n public schema: SchemaLink.Options[\"schema\"];\n public rootValue: SchemaLink.Options[\"rootValue\"];\n public context: SchemaLink.Options[\"context\"];\n public validate: boolean;\n\n constructor(options: SchemaLink.Options) {\n super();\n this.schema = options.schema;\n this.rootValue = options.rootValue;\n this.context = options.context;\n this.validate = !!options.validate;\n }\n\n public request(\n operation: ApolloLink.Operation\n ): Observable<ApolloLink.Result> {\n return new Observable<ApolloLink.Result>((observer) => {\n new Promise<SchemaLink.ResolverContext>((resolve) =>\n resolve(\n typeof this.context === \"function\" ?\n this.context(operation)\n : this.context\n )\n )\n .then((context) => {\n if (this.validate) {\n const validationErrors = validate(this.schema, operation.query);\n if (validationErrors.length > 0) {\n return { errors: validationErrors };\n }\n }\n\n return execute({\n schema: this.schema,\n document: operation.query,\n rootValue: this.rootValue,\n contextValue: context,\n variableValues: operation.variables,\n operationName: operation.operationName,\n });\n })\n .then((data) => {\n if (!observer.closed) {\n observer.next(data);\n observer.complete();\n }\n })\n .catch((error) => {\n if (!observer.closed) {\n observer.error(error);\n }\n });\n });\n }\n}\n"],"names":[],"mappings":";;;AACA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAEA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAgCA,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAgC,CAAhC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA;IACS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAe;IACN,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkB;IACT,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgB;IACP,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiB;IAEf,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAc,CAAd,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyC,EAAzC;QACI,CAAJ,CAAA,CAAA,CAAA,CAAS,CAAT,CAAW;QACP,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,EAAA,EAAkB,CAAlB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAC,CAA1B,CAAA,CAAA,CAAA,CAAA,CAAgC;QAC5B,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAqB,CAArB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA4B,CAAC,CAA7B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsC;QAClC,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAmB,CAAnB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0B,CAAC,CAA3B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkC;QAC9B,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAoB,CAAC,CAAC,CAAtB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,CAAC,CAA9B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsC;IACpC;IAEO,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgB,CACZ,CADJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACmC,EADnC;QAGI,CAAJ,CAAA,CAAA,CAAA,CAAA,EAAW,CAAX,CAAA,EAAe,CAAf,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAoB,CAAC,CAA9C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsD,EAAE,CAAxD,EAAA;YACM,CAAN,CAAA,EAAU,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiB,CAA6B,CAAC,CAA/C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsD,EAAE,CAAxD,EACQ,CADR,CAAA,CAAA,CAAA,CAAA,CAAA,CACe,CACL,CAFV,CAAA,CAAA,CAAA,CAAA,EAEiB,CAFjB,CAAA,CAAA,CAEqB,CAAC,CAFtB,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAEkC,CAFlC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAE6C;gBACjC,CAAZ,CAAA,CAAA,CAAgB,CAAC,CAAjB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwB,CAAC,CAAzB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkC;gBACxB,EAAE,CAAZ,CAAA,CAAA,CAAgB,CAAC,CAAjB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwB,CACf;gBAET,CAAS,CAAT,CAAA,CAAA,CAAa,CAAC,CAAC,CAAf,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsB,EAAE,CAAxB,EAAA;gBACU,CAAV,EAAA,CAAc,CAAd,CAAA,CAAA,CAAkB,CAAC,CAAnB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA2B,EAAE;oBACjB,CAAZ,CAAA,CAAA,CAAA,EAAkB,CAAlB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAqC,CAArC,CAAA,EAAqC,CAArC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6C,CAA7C,CAA8C,CAA9C,CAAA,CAAA,CAAkD,CAAC,CAAnD,CAAA,CAAA,CAAA,CAAA,CAAyD,EAAE,CAA3D,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoE,CAAC,CAArE,CAAA,CAAA,CAAA,CAA0E,CAAC;oBAC/D,CAAZ,EAAA,CAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgC,CAAC,CAAjC,CAAA,CAAA,CAAA,CAAA,EAAA,EAA0C,CAAC,EAAE;wBAC/B,CAAd,CAAA,CAAA,CAAA,CAAA,EAAqB,EAAE,CAAvB,CAAA,CAAA,CAAA,CAAA,CAA6B,EAAE,CAA/B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAiD;oBACrC;gBACF;gBAEA,CAAV,CAAA,CAAA,CAAA,CAAA,EAAiB,CAAjB,CAAA,EAAiB,CAAjB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwB,CAAxB,CAAyB;oBACb,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAkB,EAAE,CAApB,CAAA,CAAA,CAAwB,CAAC,CAAzB,CAAA,CAAA,CAAA,CAAA,CAA+B;oBACnB,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,EAAE,CAAtB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA+B,CAAC,CAAhC,CAAA,CAAA,CAAA,CAAqC;oBACzB,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqB,EAAE,CAAvB,CAAA,CAAA,CAA2B,CAAC,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqC;oBACzB,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwB,EAAE,CAA1B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiC;oBACrB,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0B,EAAE,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqC,CAAC,CAAtC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA+C;oBACnC,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,EAAE,CAA3B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoC,CAAC,CAArC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkD;gBAClD,CAAW,CAAC;YACJ,CAAC;gBACT,CAAS,CAAT,CAAA,CAAA,CAAa,CAAC,CAAC,CAAf,CAAA,CAAA,CAAmB,EAAE,CAArB,EAAA;gBACU,CAAV,EAAA,CAAc,CAAC,CAAf,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuB,CAAC,CAAxB,CAAA,CAAA,CAAA,CAAA,CAA8B,EAAE;oBACpB,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,CAAC,CAArB,CAAA,CAAA,CAAyB,CAAC,CAA1B,CAAA,CAAA,CAA8B,CAAC;oBACnB,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,CAAC,CAArB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,CAA7B,CAA+B;gBACrB;YACF,CAAC;gBACT,CAAS,CAAT,CAAA,CAAA,CAAA,CAAc,CAAC,CAAC,CAAhB,CAAA,CAAA,CAAA,CAAqB,EAAE,CAAvB,EAAA;gBACU,CAAV,EAAA,CAAc,CAAC,CAAf,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuB,CAAC,CAAxB,CAAA,CAAA,CAAA,CAAA,CAA8B,EAAE;oBACpB,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,CAAC,CAArB,CAAA,CAAA,CAAA,CAA0B,CAAC,CAA3B,CAAA,CAAA,CAAA,CAAgC,CAAC;gBACvB;YACF,CAAC,CAAC;QACN,CAAC,CAAC;IACJ;AACF;AAvDA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;"}
1
+ {"version":3,"file":"index.cjs","sources":["../../../../src/link/schema/index.ts"],"sourcesContent":["import type { GraphQLSchema } from \"graphql\";\nimport { execute, validate } from \"graphql\";\nimport { Observable } from \"rxjs\";\n\nimport { ApolloLink } from \"@apollo/client/link\";\n\nexport declare namespace SchemaLink {\n export namespace SchemaLinkDocumentationTypes {\n /**\n * A function that returns the resolver context for a given operation.\n *\n * This function is called for each operation and allows you to create\n * operation-specific context. This is useful when you need to include\n * information from the operation (like headers, variables, etc.) in the\n * resolver context.\n *\n * @param operation - The Apollo Link operation\n * @returns The resolver context object or a promise that resolves to the context\n *\n * @example\n *\n * ```ts\n * const link = new SchemaLink({\n * schema,\n * context: (operation) => {\n * return {\n * userId: operation.getContext().userId,\n * dataSources: {\n * userAPI: new UserAPI(),\n * },\n * };\n * },\n * });\n * ```\n */\n export function ResolverContextFunction(\n operation: ApolloLink.Operation\n ): SchemaLink.ResolverContext | PromiseLike<SchemaLink.ResolverContext>;\n }\n /**\n * The resolver context object passed to GraphQL resolvers.\n *\n * This context object is passed as the third parameter to GraphQL resolvers\n * and typically contains data-fetching connectors, authentication information,\n * and other request-specific data.\n */\n export type ResolverContext = Record<string, any>;\n\n /** {@inheritDoc @apollo/client/link/schema!SchemaLink.SchemaLinkDocumentationTypes.ResolverContextFunction:function(1)} */\n export type ResolverContextFunction = (\n operation: ApolloLink.Operation\n ) => SchemaLink.ResolverContext | PromiseLike<SchemaLink.ResolverContext>;\n\n /**\n * Options for configuring the `SchemaLink`.\n */\n export interface Options {\n /**\n * An executable GraphQL schema to use for operation execution.\n *\n * @remarks\n *\n * This should be a complete, executable GraphQL schema created using\n * tools like `makeExecutableSchema` from `@graphql-tools/schema` or\n * `buildSchema` from `graphql`.\n *\n * @example\n *\n * ```ts\n * import { makeExecutableSchema } from \"@graphql-tools/schema\";\n *\n * const schema = makeExecutableSchema({\n * typeDefs,\n * resolvers,\n * });\n *\n * const link = new SchemaLink({ schema });\n * ```\n */\n schema: GraphQLSchema;\n\n /**\n * The root value passed to root-level resolvers. It's typically not used in\n * most schemas but can be useful for certain advanced patterns.\n */\n rootValue?: any;\n\n /**\n * Context object or function that returns the context object to provide to\n * resolvers. The context is passed as the third parameter to all GraphQL\n * resolvers.\n *\n * - If a static object is provided, the same context will be used for all\n * operations\n * - If a function is provided, the function is called for each operation to\n * generate operation-specific context\n */\n context?: SchemaLink.ResolverContext | SchemaLink.ResolverContextFunction;\n\n /**\n * Whether to validate incoming queries against the schema before execution.\n *\n * When enabled, queries will be validated against the schema before execution,\n * and validation errors will be returned in the result's `errors` array,\n * just like a remote GraphQL server would.\n *\n * This is useful for testing and development to catch query errors early,\n * but may add overhead in production environments.\n *\n * @defaultValue false\n */\n validate?: boolean;\n }\n}\n\n/**\n * `SchemaLink` is a terminating link that executes GraphQL operations against\n * a local GraphQL schema instead of making network requests. This is commonly\n * used for server-side rendering (SSR) and mocking dataa.\n *\n * > [!NOTE]\n * > While `SchemaLink` can provide GraphQL results on the client, the GraphQL\n * > execution layer is [quite large](https://bundlephobia.com/result?p=graphql) for practical client-side use.\n * > For client-side state management, consider Apollo Client's [local state management](https://apollographql.com/docs/react/local-state/local-state-management/)\n * > functionality instead, which integrates with the Apollo Client cache.\n *\n * @example\n *\n * ```ts\n * import { SchemaLink } from \"@apollo/client/link/schema\";\n * import schema from \"./path/to/your/schema\";\n *\n * const link = new SchemaLink({ schema });\n * ```\n */\nexport class SchemaLink extends ApolloLink {\n public schema: SchemaLink.Options[\"schema\"];\n public rootValue: SchemaLink.Options[\"rootValue\"];\n public context: SchemaLink.Options[\"context\"];\n public validate: boolean;\n\n constructor(options: SchemaLink.Options) {\n super();\n this.schema = options.schema;\n this.rootValue = options.rootValue;\n this.context = options.context;\n this.validate = !!options.validate;\n }\n\n public request(\n operation: ApolloLink.Operation\n ): Observable<ApolloLink.Result> {\n return new Observable<ApolloLink.Result>((observer) => {\n new Promise<SchemaLink.ResolverContext>((resolve) =>\n resolve(\n typeof this.context === \"function\" ?\n this.context(operation)\n : this.context\n )\n )\n .then((context) => {\n if (this.validate) {\n const validationErrors = validate(this.schema, operation.query);\n if (validationErrors.length > 0) {\n return { errors: validationErrors };\n }\n }\n\n return execute({\n schema: this.schema,\n document: operation.query,\n rootValue: this.rootValue,\n contextValue: context,\n variableValues: operation.variables,\n operationName: operation.operationName,\n });\n })\n .then((data) => {\n if (!observer.closed) {\n observer.next(data);\n observer.complete();\n }\n })\n .catch((error) => {\n if (!observer.closed) {\n observer.error(error);\n }\n });\n });\n }\n}\n"],"names":[],"mappings":";;;AACA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAEA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AA+GA,CAAA,CAAA;;;;;;;;;;;;;;;;;;;CAmBA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAgC,CAAhC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA;IACS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAe;IACN,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkB;IACT,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgB;IACP,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiB;IAEf,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAc,CAAd,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyC,EAAzC;QACI,CAAJ,CAAA,CAAA,CAAA,CAAS,CAAT,CAAW;QACP,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,EAAA,EAAkB,CAAlB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAC,CAA1B,CAAA,CAAA,CAAA,CAAA,CAAgC;QAC5B,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAqB,CAArB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA4B,CAAC,CAA7B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsC;QAClC,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAmB,CAAnB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0B,CAAC,CAA3B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkC;QAC9B,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAoB,CAAC,CAAC,CAAtB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,CAAC,CAA9B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsC;IACpC;IAEO,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgB,CACZ,CADJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACmC,EADnC;QAGI,CAAJ,CAAA,CAAA,CAAA,CAAA,EAAW,CAAX,CAAA,EAAe,CAAf,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAoB,CAAC,CAA9C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsD,EAAE,CAAxD,EAAA;YACM,CAAN,CAAA,EAAU,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiB,CAA6B,CAAC,CAA/C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsD,EAAE,CAAxD,EACQ,CADR,CAAA,CAAA,CAAA,CAAA,CAAA,CACe,CACL,CAFV,CAAA,CAAA,CAAA,CAAA,EAEiB,CAFjB,CAAA,CAAA,CAEqB,CAAC,CAFtB,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAEkC,CAFlC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAE6C;gBACjC,CAAZ,CAAA,CAAA,CAAgB,CAAC,CAAjB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwB,CAAC,CAAzB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkC;gBACxB,EAAE,CAAZ,CAAA,CAAA,CAAgB,CAAC,CAAjB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwB,CACf;gBAET,CAAS,CAAT,CAAA,CAAA,CAAa,CAAC,CAAC,CAAf,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsB,EAAE,CAAxB,EAAA;gBACU,CAAV,EAAA,CAAc,CAAd,CAAA,CAAA,CAAkB,CAAC,CAAnB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA2B,EAAE;oBACjB,CAAZ,CAAA,CAAA,CAAA,EAAkB,CAAlB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAqC,CAArC,CAAA,EAAqC,CAArC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6C,CAA7C,CAA8C,CAA9C,CAAA,CAAA,CAAkD,CAAC,CAAnD,CAAA,CAAA,CAAA,CAAA,CAAyD,EAAE,CAA3D,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoE,CAAC,CAArE,CAAA,CAAA,CAAA,CAA0E,CAAC;oBAC/D,CAAZ,EAAA,CAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgC,CAAC,CAAjC,CAAA,CAAA,CAAA,CAAA,EAAA,EAA0C,CAAC,EAAE;wBAC/B,CAAd,CAAA,CAAA,CAAA,CAAA,EAAqB,EAAE,CAAvB,CAAA,CAAA,CAAA,CAAA,CAA6B,EAAE,CAA/B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAiD;oBACrC;gBACF;gBAEA,CAAV,CAAA,CAAA,CAAA,CAAA,EAAiB,CAAjB,CAAA,EAAiB,CAAjB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwB,CAAxB,CAAyB;oBACb,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAkB,EAAE,CAApB,CAAA,CAAA,CAAwB,CAAC,CAAzB,CAAA,CAAA,CAAA,CAAA,CAA+B;oBACnB,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,EAAE,CAAtB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA+B,CAAC,CAAhC,CAAA,CAAA,CAAA,CAAqC;oBACzB,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqB,EAAE,CAAvB,CAAA,CAAA,CAA2B,CAAC,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqC;oBACzB,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwB,EAAE,CAA1B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiC;oBACrB,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0B,EAAE,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqC,CAAC,CAAtC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA+C;oBACnC,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,EAAE,CAA3B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoC,CAAC,CAArC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkD;gBAClD,CAAW,CAAC;YACJ,CAAC;gBACT,CAAS,CAAT,CAAA,CAAA,CAAa,CAAC,CAAC,CAAf,CAAA,CAAA,CAAmB,EAAE,CAArB,EAAA;gBACU,CAAV,EAAA,CAAc,CAAC,CAAf,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuB,CAAC,CAAxB,CAAA,CAAA,CAAA,CAAA,CAA8B,EAAE;oBACpB,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,CAAC,CAArB,CAAA,CAAA,CAAyB,CAAC,CAA1B,CAAA,CAAA,CAA8B,CAAC;oBACnB,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,CAAC,CAArB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,CAA7B,CAA+B;gBACrB;YACF,CAAC;gBACT,CAAS,CAAT,CAAA,CAAA,CAAA,CAAc,CAAC,CAAC,CAAhB,CAAA,CAAA,CAAA,CAAqB,EAAE,CAAvB,EAAA;gBACU,CAAV,EAAA,CAAc,CAAC,CAAf,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuB,CAAC,CAAxB,CAAA,CAAA,CAAA,CAAA,CAA8B,EAAE;oBACpB,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,CAAC,CAArB,CAAA,CAAA,CAAA,CAA0B,CAAC,CAA3B,CAAA,CAAA,CAAA,CAAgC,CAAC;gBACvB;YACF,CAAC,CAAC;QACN,CAAC,CAAC;IACJ;AACF;AAvDA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;"}
@@ -2,28 +2,150 @@ import type { GraphQLSchema } from "graphql";
2
2
  import { Observable } from "rxjs";
3
3
  import { ApolloLink } from "@apollo/client/link";
4
4
  export declare namespace SchemaLink {
5
+ namespace SchemaLinkDocumentationTypes {
6
+ /**
7
+ * A function that returns the resolver context for a given operation.
8
+ *
9
+ * This function is called for each operation and allows you to create
10
+ * operation-specific context. This is useful when you need to include
11
+ * information from the operation (like headers, variables, etc.) in the
12
+ * resolver context.
13
+ *
14
+ * @param operation - The Apollo Link operation
15
+ * @returns The resolver context object or a promise that resolves to the context
16
+ *
17
+ * @example
18
+ *
19
+ * ```ts
20
+ * const link = new SchemaLink({
21
+ * schema,
22
+ * context: (operation) => {
23
+ * return {
24
+ * userId: operation.getContext().userId,
25
+ * dataSources: {
26
+ * userAPI: new UserAPI(),
27
+ * },
28
+ * };
29
+ * },
30
+ * });
31
+ * ```
32
+ */
33
+ function ResolverContextFunction(operation: ApolloLink.Operation): SchemaLink.ResolverContext | PromiseLike<SchemaLink.ResolverContext>;
34
+ }
35
+ /**
36
+ * The resolver context object passed to GraphQL resolvers.
37
+ *
38
+ * This context object is passed as the third parameter to GraphQL resolvers
39
+ * and typically contains data-fetching connectors, authentication information,
40
+ * and other request-specific data.
41
+ */
5
42
  type ResolverContext = Record<string, any>;
6
- type ResolverContextFunction = (operation: ApolloLink.Operation) => ResolverContext | PromiseLike<ResolverContext>;
43
+ /**
44
+ * A function that returns the resolver context for a given operation.
45
+ *
46
+ * This function is called for each operation and allows you to create
47
+ * operation-specific context. This is useful when you need to include
48
+ * information from the operation (like headers, variables, etc.) in the
49
+ * resolver context.
50
+ *
51
+ * @param operation - The Apollo Link operation
52
+ * @returns The resolver context object or a promise that resolves to the context
53
+ *
54
+ * @example
55
+ *
56
+ * ```ts
57
+ * const link = new SchemaLink({
58
+ * schema,
59
+ * context: (operation) => {
60
+ * return {
61
+ * userId: operation.getContext().userId,
62
+ * dataSources: {
63
+ * userAPI: new UserAPI(),
64
+ * },
65
+ * };
66
+ * },
67
+ * });
68
+ * ```
69
+ */
70
+ type ResolverContextFunction = (operation: ApolloLink.Operation) => SchemaLink.ResolverContext | PromiseLike<SchemaLink.ResolverContext>;
71
+ /**
72
+ * Options for configuring the `SchemaLink`.
73
+ */
7
74
  interface Options {
8
75
  /**
9
- * The schema to generate responses from.
76
+ * An executable GraphQL schema to use for operation execution.
77
+ *
78
+ * @remarks
79
+ *
80
+ * This should be a complete, executable GraphQL schema created using
81
+ * tools like `makeExecutableSchema` from `@graphql-tools/schema` or
82
+ * `buildSchema` from `graphql`.
83
+ *
84
+ * @example
85
+ *
86
+ * ```ts
87
+ * import { makeExecutableSchema } from "@graphql-tools/schema";
88
+ *
89
+ * const schema = makeExecutableSchema({
90
+ * typeDefs,
91
+ * resolvers,
92
+ * });
93
+ *
94
+ * const link = new SchemaLink({ schema });
95
+ * ```
10
96
  */
11
97
  schema: GraphQLSchema;
12
98
  /**
13
- * The root value to use when generating responses.
99
+ * The root value passed to root-level resolvers. It's typically not used in
100
+ * most schemas but can be useful for certain advanced patterns.
14
101
  */
15
102
  rootValue?: any;
16
103
  /**
17
- * A context to provide to resolvers declared within the schema.
104
+ * Context object or function that returns the context object to provide to
105
+ * resolvers. The context is passed as the third parameter to all GraphQL
106
+ * resolvers.
107
+ *
108
+ * - If a static object is provided, the same context will be used for all
109
+ * operations
110
+ * - If a function is provided, the function is called for each operation to
111
+ * generate operation-specific context
18
112
  */
19
113
  context?: SchemaLink.ResolverContext | SchemaLink.ResolverContextFunction;
20
114
  /**
21
- * Validate incoming queries against the given schema, returning
22
- * validation errors as a GraphQL server would.
115
+ * Whether to validate incoming queries against the schema before execution.
116
+ *
117
+ * When enabled, queries will be validated against the schema before execution,
118
+ * and validation errors will be returned in the result's `errors` array,
119
+ * just like a remote GraphQL server would.
120
+ *
121
+ * This is useful for testing and development to catch query errors early,
122
+ * but may add overhead in production environments.
123
+ *
124
+ * @defaultValue false
23
125
  */
24
126
  validate?: boolean;
25
127
  }
26
128
  }
129
+ /**
130
+ * `SchemaLink` is a terminating link that executes GraphQL operations against
131
+ * a local GraphQL schema instead of making network requests. This is commonly
132
+ * used for server-side rendering (SSR) and mocking dataa.
133
+ *
134
+ * > [!NOTE]
135
+ * > While `SchemaLink` can provide GraphQL results on the client, the GraphQL
136
+ * > execution layer is [quite large](https://bundlephobia.com/result?p=graphql) for practical client-side use.
137
+ * > For client-side state management, consider Apollo Client's [local state management](https://apollographql.com/docs/react/local-state/local-state-management/)
138
+ * > functionality instead, which integrates with the Apollo Client cache.
139
+ *
140
+ * @example
141
+ *
142
+ * ```ts
143
+ * import { SchemaLink } from "@apollo/client/link/schema";
144
+ * import schema from "./path/to/your/schema";
145
+ *
146
+ * const link = new SchemaLink({ schema });
147
+ * ```
148
+ */
27
149
  export declare class SchemaLink extends ApolloLink {
28
150
  schema: SchemaLink.Options["schema"];
29
151
  rootValue: SchemaLink.Options["rootValue"];
@@ -10,6 +10,24 @@ const link_1 = require("@apollo/client/link");
10
10
  const environment_1 = require("@apollo/client/utilities/environment");
11
11
  const invariant_1 = require("@apollo/client/utilities/invariant");
12
12
  /**
13
+ * `WebSocketLink` is a terminating link that executes GraphQL operations over
14
+ * WebSocket connections using the `subscriptions-transport-ws` library. It's
15
+ * primarily used for GraphQL subscriptions but can also handle queries and
16
+ * mutations.
17
+ *
18
+ * @example
19
+ *
20
+ * ```ts
21
+ * import { WebSocketLink } from "@apollo/client/link/ws";
22
+ * import { SubscriptionClient } from "subscriptions-transport-ws";
23
+ *
24
+ * const wsLink = new WebSocketLink(
25
+ * new SubscriptionClient("ws://localhost:4000/subscriptions", {
26
+ * reconnect: true,
27
+ * })
28
+ * );
29
+ * ```
30
+ *
13
31
  * @deprecated `WebSocketLink` uses the deprecated and unmaintained
14
32
  * `subscriptions-transport-ws` library. This link is no longer maintained and
15
33
  * will be removed in a future major version of Apollo Client. We recommend