@terreno/ui 57.20.0 → 58.0.0-beta.1

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 (297) hide show
  1. package/.ai/guidelines/core.md +1 -1
  2. package/CHANGELOG.md +93 -0
  3. package/dist/ActionSheet.d.ts +9 -9
  4. package/dist/ActionSheet.d.ts.map +1 -1
  5. package/dist/ActionSheet.js +11 -4
  6. package/dist/ActionSheet.js.map +1 -1
  7. package/dist/AnnouncementNavigator.d.ts +7 -1
  8. package/dist/AnnouncementNavigator.d.ts.map +1 -1
  9. package/dist/AnnouncementNavigator.js +15 -16
  10. package/dist/AnnouncementNavigator.js.map +1 -1
  11. package/dist/Avatar.d.ts.map +1 -1
  12. package/dist/Avatar.js +1 -1
  13. package/dist/Avatar.js.map +1 -1
  14. package/dist/Box.d.ts.map +1 -1
  15. package/dist/Box.js +3 -1
  16. package/dist/Box.js.map +1 -1
  17. package/dist/Common.d.ts +71 -39
  18. package/dist/Common.d.ts.map +1 -1
  19. package/dist/Common.js.map +1 -1
  20. package/dist/ConsentFormScreen.d.ts.map +1 -1
  21. package/dist/ConsentFormScreen.js.map +1 -1
  22. package/dist/ConsentNavigator.d.ts +5 -3
  23. package/dist/ConsentNavigator.d.ts.map +1 -1
  24. package/dist/ConsentNavigator.js +4 -4
  25. package/dist/ConsentNavigator.js.map +1 -1
  26. package/dist/CustomSelectField.js.map +1 -1
  27. package/dist/DataTable.d.ts.map +1 -1
  28. package/dist/DataTable.js +37 -12
  29. package/dist/DataTable.js.map +1 -1
  30. package/dist/DateTimeField.js +6 -6
  31. package/dist/DateTimeField.js.map +1 -1
  32. package/dist/DropdownPanel.d.ts +0 -5
  33. package/dist/DropdownPanel.d.ts.map +1 -1
  34. package/dist/DropdownPanel.js +0 -5
  35. package/dist/DropdownPanel.js.map +1 -1
  36. package/dist/FilterAccordion.d.ts.map +1 -1
  37. package/dist/FilterAccordion.js.map +1 -1
  38. package/dist/FilterBoolean.d.ts.map +1 -1
  39. package/dist/FilterBoolean.js.map +1 -1
  40. package/dist/FilterSelectMenu.js +1 -1
  41. package/dist/FilterSelectMenu.js.map +1 -1
  42. package/dist/GPTChat.d.ts.map +1 -1
  43. package/dist/GPTChat.js.map +1 -1
  44. package/dist/Heading.d.ts.map +1 -1
  45. package/dist/Heading.js +6 -12
  46. package/dist/Heading.js.map +1 -1
  47. package/dist/HeightField.d.ts.map +1 -1
  48. package/dist/HeightField.js +9 -9
  49. package/dist/HeightField.js.map +1 -1
  50. package/dist/Hyperlink.d.ts.map +1 -1
  51. package/dist/Hyperlink.js +6 -1
  52. package/dist/Hyperlink.js.map +1 -1
  53. package/dist/Image.d.ts +1 -1
  54. package/dist/MarkdownEditorField.d.ts.map +1 -1
  55. package/dist/MarkdownEditorField.js +1 -1
  56. package/dist/MarkdownEditorField.js.map +1 -1
  57. package/dist/OfflineBanner.d.ts +3 -2
  58. package/dist/OfflineBanner.d.ts.map +1 -1
  59. package/dist/OfflineBanner.js +3 -2
  60. package/dist/OfflineBanner.js.map +1 -1
  61. package/dist/OtpField.d.ts.map +1 -1
  62. package/dist/OtpField.js +4 -4
  63. package/dist/OtpField.js.map +1 -1
  64. package/dist/PickerSelect.d.ts +4 -4
  65. package/dist/PickerSelect.d.ts.map +1 -1
  66. package/dist/PickerSelect.js +9 -9
  67. package/dist/PickerSelect.js.map +1 -1
  68. package/dist/ProvisionalConsentSigner.d.ts +3 -2
  69. package/dist/ProvisionalConsentSigner.d.ts.map +1 -1
  70. package/dist/ProvisionalConsentSigner.js +2 -2
  71. package/dist/ProvisionalConsentSigner.js.map +1 -1
  72. package/dist/SidebarNavigation.js +2 -2
  73. package/dist/SidebarNavigation.js.map +1 -1
  74. package/dist/SidebarNavigation.native.js +2 -2
  75. package/dist/SidebarNavigation.native.js.map +1 -1
  76. package/dist/Skeleton.js.map +1 -1
  77. package/dist/TapToEdit.d.ts +1 -1
  78. package/dist/TapToEdit.d.ts.map +1 -1
  79. package/dist/TapToEdit.js.map +1 -1
  80. package/dist/Text.d.ts.map +1 -1
  81. package/dist/Text.js +27 -50
  82. package/dist/Text.js.map +1 -1
  83. package/dist/TextField.d.ts.map +1 -1
  84. package/dist/TextField.js +4 -4
  85. package/dist/TextField.js.map +1 -1
  86. package/dist/Theme.d.ts.map +1 -1
  87. package/dist/Theme.js +16 -0
  88. package/dist/Theme.js.map +1 -1
  89. package/dist/ThumbsUpDownFeedback.d.ts.map +1 -1
  90. package/dist/ThumbsUpDownFeedback.js.map +1 -1
  91. package/dist/ToastNotifications.d.ts.map +1 -1
  92. package/dist/ToastNotifications.js.map +1 -1
  93. package/dist/Tooltip.d.ts.map +1 -1
  94. package/dist/Tooltip.js.map +1 -1
  95. package/dist/Unifier.d.ts +1 -1
  96. package/dist/WebAddressAutocomplete.js.map +1 -1
  97. package/dist/WebDropdownMenu.d.ts +3 -3
  98. package/dist/WebDropdownMenu.d.ts.map +1 -1
  99. package/dist/WebDropdownMenu.js +1 -1
  100. package/dist/WebDropdownMenu.js.map +1 -1
  101. package/dist/announcementPlatform.d.ts +5 -0
  102. package/dist/announcementPlatform.d.ts.map +1 -1
  103. package/dist/announcementPlatform.js +9 -0
  104. package/dist/announcementPlatform.js.map +1 -1
  105. package/dist/asks/AskCard.d.ts +2 -2
  106. package/dist/asks/AskCard.d.ts.map +1 -1
  107. package/dist/dataTableColumnWidths.d.ts +76 -0
  108. package/dist/dataTableColumnWidths.d.ts.map +1 -0
  109. package/dist/dataTableColumnWidths.js +181 -0
  110. package/dist/dataTableColumnWidths.js.map +1 -0
  111. package/dist/index.d.ts +2 -1
  112. package/dist/index.d.ts.map +1 -1
  113. package/dist/index.js.map +1 -1
  114. package/dist/login/LoginScreen.js.map +1 -1
  115. package/dist/requestClient.d.ts +71 -0
  116. package/dist/requestClient.d.ts.map +1 -0
  117. package/dist/requestClient.js +139 -0
  118. package/dist/requestClient.js.map +1 -0
  119. package/dist/security/PasswordCard.d.ts.map +1 -1
  120. package/dist/security/PasswordCard.js.map +1 -1
  121. package/dist/security/TwoFactorSettingsCard.d.ts.map +1 -1
  122. package/dist/security/TwoFactorSettingsCard.js +1 -1
  123. package/dist/security/TwoFactorSettingsCard.js.map +1 -1
  124. package/dist/signUp/SignUpScreen.js.map +1 -1
  125. package/dist/table/Table.d.ts.map +1 -1
  126. package/dist/table/Table.js.map +1 -1
  127. package/dist/table/TableTitle.d.ts.map +1 -1
  128. package/dist/table/TableTitle.js +2 -1
  129. package/dist/table/TableTitle.js.map +1 -1
  130. package/dist/textFontSizes.d.ts +12 -0
  131. package/dist/textFontSizes.d.ts.map +1 -0
  132. package/dist/textFontSizes.js +21 -0
  133. package/dist/textFontSizes.js.map +1 -0
  134. package/dist/useAcknowledgeAnnouncement.d.ts +8 -63
  135. package/dist/useAcknowledgeAnnouncement.d.ts.map +1 -1
  136. package/dist/useAcknowledgeAnnouncement.js +31 -80
  137. package/dist/useAcknowledgeAnnouncement.js.map +1 -1
  138. package/dist/useAnnouncements.d.ts +14 -47
  139. package/dist/useAnnouncements.d.ts.map +1 -1
  140. package/dist/useAnnouncements.js +30 -57
  141. package/dist/useAnnouncements.js.map +1 -1
  142. package/dist/useConsentForms.d.ts +6 -38
  143. package/dist/useConsentForms.d.ts.map +1 -1
  144. package/dist/useConsentForms.js +25 -48
  145. package/dist/useConsentForms.js.map +1 -1
  146. package/dist/useProvisionalConsent.d.ts +7 -58
  147. package/dist/useProvisionalConsent.d.ts.map +1 -1
  148. package/dist/useProvisionalConsent.js +57 -67
  149. package/dist/useProvisionalConsent.js.map +1 -1
  150. package/dist/useSubmitConsent.d.ts +9 -39
  151. package/dist/useSubmitConsent.d.ts.map +1 -1
  152. package/dist/useSubmitConsent.js +10 -39
  153. package/dist/useSubmitConsent.js.map +1 -1
  154. package/package.json +40 -38
  155. package/src/ActionSheet.test.tsx +13 -13
  156. package/src/ActionSheet.tsx +18 -5
  157. package/src/AddressField.test.tsx +9 -3
  158. package/src/AnnouncementNavigator.test.tsx +219 -319
  159. package/src/AnnouncementNavigator.tsx +25 -20
  160. package/src/Avatar.tsx +2 -9
  161. package/src/Badge.test.tsx +1 -1
  162. package/src/Banner.test.tsx +0 -1
  163. package/src/Box.test.tsx +85 -77
  164. package/src/Box.tsx +4 -2
  165. package/src/Button.test.tsx +11 -6
  166. package/src/Card.test.tsx +2 -2
  167. package/src/Common.ts +79 -44
  168. package/src/ConflictSheet.test.tsx +5 -5
  169. package/src/ConsentFormScreen.test.tsx +3 -1
  170. package/src/ConsentFormScreen.tsx +2 -1
  171. package/src/ConsentNavigator.test.tsx +166 -243
  172. package/src/ConsentNavigator.tsx +9 -13
  173. package/src/CustomSelectField.test.tsx +16 -4
  174. package/src/CustomSelectField.tsx +3 -3
  175. package/src/DataTable.test.tsx +73 -5
  176. package/src/DataTable.tsx +72 -19
  177. package/src/DataTableVirtualizationRegression.test.tsx +1 -0
  178. package/src/DateTimeActionSheet.test.tsx +2 -0
  179. package/src/DateTimeField.test.tsx +3 -12
  180. package/src/DateTimeField.tsx +10 -10
  181. package/src/DismissButton.test.tsx +22 -4
  182. package/src/DropdownPanel.tsx +0 -6
  183. package/src/EmailField.test.tsx +13 -22
  184. package/src/EmojiSelector.test.tsx +2 -2
  185. package/src/ErrorBoundary.test.tsx +5 -3
  186. package/src/Field.test.tsx +20 -44
  187. package/src/FilterAccordion.tsx +3 -3
  188. package/src/FilterBoolean.tsx +3 -3
  189. package/src/FilterSelectMenu.tsx +1 -1
  190. package/src/GPTChat.test.tsx +24 -16
  191. package/src/GPTChat.tsx +10 -9
  192. package/src/Heading.test.tsx +1 -1
  193. package/src/Heading.tsx +7 -14
  194. package/src/HeightField.tsx +17 -10
  195. package/src/Hyperlink.tsx +6 -3
  196. package/src/Icon.test.tsx +2 -2
  197. package/src/Image.test.tsx +1 -1
  198. package/src/Link.test.tsx +13 -6
  199. package/src/MarkdownEditorField.tsx +10 -2
  200. package/src/MarkdownView.test.tsx +10 -6
  201. package/src/MobileAddressAutoComplete.test.tsx +2 -1
  202. package/src/Modal.test.tsx +10 -3
  203. package/src/ModalSheet.test.tsx +11 -10
  204. package/src/MultiselectField.test.tsx +17 -3
  205. package/src/NumberField.test.tsx +14 -14
  206. package/src/NumberPickerActionSheet.test.tsx +1 -1
  207. package/src/OfflineBanner.tsx +3 -2
  208. package/src/OpenAPIContext.test.tsx +4 -4
  209. package/src/OpenAPIRenderRegression.test.tsx +1 -1
  210. package/src/OtpField.tsx +6 -5
  211. package/src/P0RenderRegression.test.tsx +7 -1
  212. package/src/P1RenderRegression.test.tsx +1 -0
  213. package/src/P2ButtonRenderRegression.test.tsx +1 -0
  214. package/src/Page.test.tsx +1 -1
  215. package/src/PhoneNumberField.test.tsx +14 -38
  216. package/src/PickerSelect.tsx +12 -11
  217. package/src/Popover.test.tsx +2 -2
  218. package/src/ProvisionalConsentSigner.test.tsx +140 -113
  219. package/src/ProvisionalConsentSigner.tsx +5 -4
  220. package/src/RadioField.test.tsx +7 -2
  221. package/src/SegmentedControl.test.tsx +21 -12
  222. package/src/SidebarNavigation.native.tsx +2 -2
  223. package/src/SidebarNavigation.test.tsx +18 -6
  224. package/src/SidebarNavigation.tsx +2 -2
  225. package/src/Signature.test.tsx +20 -23
  226. package/src/Skeleton.tsx +1 -1
  227. package/src/Slider.test.tsx +1 -1
  228. package/src/SplitPage.test.tsx +15 -5
  229. package/src/TapToEdit.test.tsx +40 -17
  230. package/src/TapToEdit.tsx +1 -1
  231. package/src/TerrenoFontProvider.test.tsx +1 -1
  232. package/src/Text.test.tsx +4 -4
  233. package/src/Text.tsx +25 -51
  234. package/src/TextField.test.tsx +82 -9
  235. package/src/TextField.tsx +6 -5
  236. package/src/Theme.test.tsx +49 -0
  237. package/src/Theme.tsx +16 -0
  238. package/src/ThumbsUpDownFeedback.tsx +3 -3
  239. package/src/Toast.test.tsx +5 -5
  240. package/src/ToastNotifications.test.tsx +73 -70
  241. package/src/ToastNotifications.tsx +3 -2
  242. package/src/ToastNotifications.webModal.test.tsx +6 -3
  243. package/src/Tooltip.test.tsx +3 -3
  244. package/src/Tooltip.tsx +2 -1
  245. package/src/UnifiedAddressAutoComplete.test.tsx +1 -1
  246. package/src/UserInactivity.test.tsx +1 -0
  247. package/src/WebAddressAutocomplete.test.tsx +12 -12
  248. package/src/WebAddressAutocomplete.tsx +3 -3
  249. package/src/WebDropdownMenu.test.tsx +16 -15
  250. package/src/WebDropdownMenu.tsx +16 -5
  251. package/src/__snapshots__/Card.test.tsx.snap +1 -1
  252. package/src/__snapshots__/DataTable.test.tsx.snap +13 -0
  253. package/src/__snapshots__/DismissButton.test.tsx.snap +3 -3
  254. package/src/__snapshots__/Field.test.tsx.snap +4 -2
  255. package/src/__snapshots__/Heading.test.tsx.snap +1 -1
  256. package/src/__snapshots__/Image.test.tsx.snap +1 -1
  257. package/src/__snapshots__/Page.test.tsx.snap +2 -2
  258. package/src/__snapshots__/Text.test.tsx.snap +1 -1
  259. package/src/announcementPlatform.ts +10 -0
  260. package/src/asks/AskCard.test.tsx +20 -15
  261. package/src/asks/AskCard.tsx +2 -2
  262. package/src/asks/AskFiles.test.tsx +5 -1
  263. package/src/asks/askFileRefs.test.ts +1 -1
  264. package/src/asks/askSummary.test.ts +2 -2
  265. package/src/benchmarks/importTiming.ts +1 -1
  266. package/src/blocks/BlocksView.test.tsx +20 -11
  267. package/src/bunSetup.ts +43 -1
  268. package/src/dataTableColumnWidths.test.ts +266 -0
  269. package/src/dataTableColumnWidths.ts +272 -0
  270. package/src/dataTableFilters.test.tsx +1 -1
  271. package/src/index.tsx +9 -2
  272. package/src/isolated/ListDetailLayout.isolated.tsx +2 -4
  273. package/src/login/LoginScreen.test.tsx +6 -6
  274. package/src/login/LoginScreen.tsx +2 -2
  275. package/src/requestClient.test.ts +288 -0
  276. package/src/requestClient.ts +228 -0
  277. package/src/security/PasswordCard.test.tsx +3 -3
  278. package/src/security/PasswordCard.tsx +7 -5
  279. package/src/security/TwoFactorSettingsCard.tsx +10 -3
  280. package/src/signUp/SignUpScreen.test.tsx +4 -4
  281. package/src/signUp/SignUpScreen.tsx +2 -2
  282. package/src/table/Table.tsx +1 -2
  283. package/src/table/TableTitle.tsx +2 -1
  284. package/src/table/tableContext.test.tsx +5 -5
  285. package/src/test-utils.tsx +132 -1
  286. package/src/testing/reactDomServer.d.ts +7 -0
  287. package/src/textFontSizes.ts +31 -0
  288. package/src/useAcknowledgeAnnouncement.test.ts +101 -193
  289. package/src/useAcknowledgeAnnouncement.ts +69 -147
  290. package/src/useAnnouncements.test.ts +122 -186
  291. package/src/useAnnouncements.ts +49 -105
  292. package/src/useConsentForms.test.ts +59 -112
  293. package/src/useConsentForms.ts +37 -87
  294. package/src/useProvisionalConsent.test.ts +74 -150
  295. package/src/useProvisionalConsent.ts +79 -125
  296. package/src/useSubmitConsent.test.ts +59 -85
  297. package/src/useSubmitConsent.ts +22 -77
@@ -1,6 +1,6 @@
1
1
  import {afterEach, describe, expect, it, mock} from "bun:test";
2
- import {renderHook} from "@testing-library/react-native";
3
- import {assert} from "chai";
2
+ import {act, renderHook, waitFor} from "@testing-library/react-native";
3
+ import {Platform} from "react-native";
4
4
 
5
5
  const constantsState = {
6
6
  expoConfig: {
@@ -14,213 +14,149 @@ mock.module("expo-constants", () => ({
14
14
  default: constantsState,
15
15
  }));
16
16
 
17
- import {useAnnouncements} from "./useAnnouncements";
18
-
19
- type AnnouncementsApi = Parameters<typeof useAnnouncements>[0];
20
-
21
- interface MockQueryDef {
22
- query: (args?: {page?: number; limit?: number}) => string;
23
- }
24
-
25
- interface MockInjectOpts {
26
- endpoints: (build: {query: (def: MockQueryDef) => string}) => Record<string, unknown>;
27
- }
17
+ import {createFakeRequestClient, fakeHttpError} from "./test-utils";
18
+ import {useAcknowledgeAnnouncement} from "./useAcknowledgeAnnouncement";
19
+ import {type AnnouncementPublic, useAnnouncements} from "./useAnnouncements";
20
+
21
+ const feedItem: AnnouncementPublic = {
22
+ body: "Body",
23
+ id: "feed-1",
24
+ priority: 0,
25
+ requiresAcknowledgement: false,
26
+ title: "Feed",
27
+ version: 1,
28
+ };
28
29
 
29
30
  describe("useAnnouncements", () => {
31
+ const originalOS = Platform.OS;
32
+
30
33
  afterEach(() => {
31
34
  constantsState.expoConfig.extra.buildNumber = undefined;
35
+ Platform.OS = originalOS;
32
36
  });
33
37
 
34
- const buildApi = ({
35
- feedData,
36
- pendingData,
37
- feedError,
38
- pendingError,
39
- }: {
40
- feedData?: unknown;
41
- pendingData?: unknown;
42
- feedError?: unknown;
43
- pendingError?: unknown;
44
- }) => {
45
- const refetchPending = mock(() => Promise.resolve());
46
- const refetchFeed = mock(() => Promise.resolve());
47
- const useGetPendingAnnouncementsQuery = mock(() => ({
48
- data: pendingData,
49
- error: pendingError,
50
- isLoading: false,
51
- refetch: refetchPending,
52
- }));
53
- const useGetAnnouncementFeedQuery = mock(() => ({
54
- data: feedData,
55
- error: feedError,
56
- isLoading: false,
57
- refetch: refetchFeed,
58
- }));
59
- const api = {
60
- enhanceEndpoints: mock(() => ({
61
- injectEndpoints: mock((opts: MockInjectOpts) => {
62
- const build = {
63
- query: mock((def: MockQueryDef) => {
64
- const pendingUrl = def.query();
65
- const feedUrl = def.query({limit: 5, page: 2});
66
- expect(
67
- pendingUrl.includes("/announcements/pending") ||
68
- feedUrl.includes("/announcements/feed")
69
- ).toBe(true);
70
- return "query";
71
- }),
72
- };
73
- opts.endpoints(build);
74
- return {useGetAnnouncementFeedQuery, useGetPendingAnnouncementsQuery};
75
- }),
76
- })),
77
- };
78
- return {api, refetchFeed, refetchPending};
79
- };
80
-
81
- it("unwraps pending and feed payloads", () => {
82
- const {api} = buildApi({
83
- feedData: {
84
- data: [
85
- {
86
- body: "Body",
87
- id: "feed-1",
88
- priority: 0,
89
- requiresAcknowledgement: false,
90
- title: "Feed",
91
- version: 1,
92
- },
93
- ],
94
- },
95
- pendingData: {data: {current: null, remainingCount: 0}},
38
+ it("unwraps pending and feed payloads", async () => {
39
+ const {client} = createFakeRequestClient({
40
+ "GET /api/announcements/feed": () => ({data: [feedItem]}),
41
+ "GET /api/announcements/pending": () => ({data: {current: null, remainingCount: 0}}),
96
42
  });
97
- const {result} = renderHook(() => useAnnouncements(api as unknown as AnnouncementsApi, "/api"));
98
- expect(result.current.pending?.remainingCount).toBe(0);
99
- expect(result.current.feed).toHaveLength(1);
43
+ const {result} = renderHook(() => useAnnouncements(client, "/api"));
44
+ expect(result.current.isLoading).toBe(true);
45
+ await waitFor(() => expect(result.current.pending?.remainingCount).toBe(0));
46
+ await waitFor(() => expect(result.current.feed).toHaveLength(1));
100
47
  expect(result.current.feed[0]?.id).toBe("feed-1");
48
+ expect(result.current.isLoading).toBe(false);
49
+ expect(result.current.isFeedLoading).toBe(false);
101
50
  });
102
51
 
103
- it("surfaces pending errors without treating feed errors as blocking", () => {
104
- const {api} = buildApi({
105
- feedError: new Error("feed failed"),
106
- pendingError: new Error("pending failed"),
52
+ it("accepts bare payloads from clients that already unwrap envelopes", async () => {
53
+ const {client} = createFakeRequestClient({
54
+ "GET /announcements/feed": () => [feedItem],
55
+ "GET /announcements/pending": () => ({current: null, remainingCount: 2}),
107
56
  });
108
- const {result} = renderHook(() => useAnnouncements(api as unknown as AnnouncementsApi));
109
- expect(result.current.error).toEqual(new Error("pending failed"));
110
- expect(result.current.feedError).toEqual(new Error("feed failed"));
57
+ const {result} = renderHook(() => useAnnouncements(client));
58
+ await waitFor(() => expect(result.current.pending?.remainingCount).toBe(2));
59
+ await waitFor(() => expect(result.current.feed).toHaveLength(1));
111
60
  });
112
61
 
113
- it("keeps feed errors separate from pending errors", () => {
114
- const {api} = buildApi({
115
- feedError: new Error("feed failed"),
116
- pendingData: {data: {current: null, remainingCount: 0}},
62
+ it("returns an empty feed when the feed envelope has no data", async () => {
63
+ const {client} = createFakeRequestClient({
64
+ "GET /announcements/feed": () => ({}),
65
+ "GET /announcements/pending": () => ({current: null, remainingCount: 0}),
117
66
  });
118
- const {result} = renderHook(() => useAnnouncements(api as unknown as AnnouncementsApi));
119
- expect(result.current.error).toBeUndefined();
120
- expect(result.current.feedError).toEqual(new Error("feed failed"));
67
+ const {result} = renderHook(() => useAnnouncements(client));
68
+ await waitFor(() => expect(result.current.isFeedLoading).toBe(false));
69
+ expect(result.current.feed).toEqual([]);
121
70
  });
122
71
 
123
- it("caches enhanced api per base url", () => {
124
- let injectCount = 0;
125
- const api = {
126
- enhanceEndpoints: () => ({
127
- injectEndpoints: () => {
128
- injectCount += 1;
129
- return {
130
- useGetAnnouncementFeedQuery: () => ({
131
- data: [],
132
- error: undefined,
133
- isLoading: false,
134
- refetch: () => Promise.resolve(),
135
- }),
136
- useGetPendingAnnouncementsQuery: () => ({
137
- data: undefined,
138
- error: undefined,
139
- isLoading: false,
140
- refetch: () => Promise.resolve(),
141
- }),
142
- };
143
- },
144
- }),
145
- };
146
- const {rerender} = renderHook(() =>
147
- useAnnouncements(api as unknown as AnnouncementsApi, "/api")
148
- );
149
- rerender(undefined);
150
- expect(injectCount).toBe(1);
72
+ it("surfaces pending errors without treating feed errors as blocking", async () => {
73
+ const pendingFailure = fakeHttpError(500, "pending failed");
74
+ const feedFailure = fakeHttpError(500, "feed failed");
75
+ const {client} = createFakeRequestClient({
76
+ "GET /announcements/feed": () => {
77
+ throw feedFailure;
78
+ },
79
+ "GET /announcements/pending": () => {
80
+ throw pendingFailure;
81
+ },
82
+ });
83
+ const {result} = renderHook(() => useAnnouncements(client));
84
+ await waitFor(() => expect(result.current.error).toBe(pendingFailure));
85
+ await waitFor(() => expect(result.current.feedError).toBe(feedFailure));
151
86
  });
152
87
 
153
- it("includes platform and version query params when build number is valid", () => {
154
- constantsState.expoConfig.extra.buildNumber = 42;
155
- const capturedUrls: string[] = [];
156
- const api = {
157
- enhanceEndpoints: () => ({
158
- injectEndpoints: (opts: MockInjectOpts) => {
159
- const build = {
160
- query: (def: MockQueryDef) => {
161
- capturedUrls.push(def.query());
162
- capturedUrls.push(def.query({limit: 5, page: 2}));
163
- return "query";
164
- },
165
- };
166
- opts.endpoints(build);
167
- return {
168
- useGetAnnouncementFeedQuery: () => ({
169
- data: [],
170
- error: undefined,
171
- isLoading: false,
172
- refetch: () => Promise.resolve(),
173
- }),
174
- useGetPendingAnnouncementsQuery: () => ({
175
- data: undefined,
176
- error: undefined,
177
- isLoading: false,
178
- refetch: () => Promise.resolve(),
179
- }),
180
- };
181
- },
182
- }),
183
- };
184
-
185
- renderHook(() => useAnnouncements(api as unknown as AnnouncementsApi, "/api"));
88
+ it("keeps feed errors separate from pending errors", async () => {
89
+ const feedFailure = fakeHttpError(500, "feed failed");
90
+ const {client} = createFakeRequestClient({
91
+ "GET /announcements/feed": () => {
92
+ throw feedFailure;
93
+ },
94
+ "GET /announcements/pending": () => ({current: null, remainingCount: 0}),
95
+ });
96
+ const {result} = renderHook(() => useAnnouncements(client));
97
+ await waitFor(() => expect(result.current.feedError).toBe(feedFailure));
98
+ expect(result.current.error).toBeUndefined();
99
+ });
186
100
 
187
- assert.ok(capturedUrls.some((url) => url.includes("platform=ios")));
188
- assert.ok(capturedUrls.some((url) => url.includes("version=42")));
101
+ it("sends platform, version, and feed paging params when build number is valid", async () => {
102
+ constantsState.expoConfig.extra.buildNumber = 42;
103
+ Platform.OS = "ios";
104
+ const {client, callsTo} = createFakeRequestClient({
105
+ "GET /api/announcements/feed": () => [],
106
+ "GET /api/announcements/pending": () => ({current: null, remainingCount: 0}),
107
+ });
108
+ const {result} = renderHook(() => useAnnouncements(client, "/api", {limit: 5, page: 2}));
109
+ await waitFor(() => expect(result.current.isFeedLoading).toBe(false));
110
+ expect(callsTo("GET /api/announcements/pending")[0]?.params).toEqual({
111
+ platform: "ios",
112
+ version: 42,
113
+ });
114
+ expect(callsTo("GET /api/announcements/feed")[0]?.params).toEqual({
115
+ limit: 5,
116
+ page: 2,
117
+ platform: "ios",
118
+ version: 42,
119
+ });
189
120
  });
190
121
 
191
- it("omits version when build number is invalid", () => {
122
+ it("omits version and defaults feed paging when build number is invalid", async () => {
192
123
  constantsState.expoConfig.extra.buildNumber = "invalid";
193
- const capturedUrls: string[] = [];
194
- const api = {
195
- enhanceEndpoints: () => ({
196
- injectEndpoints: (opts: MockInjectOpts) => {
197
- const build = {
198
- query: (def: MockQueryDef) => {
199
- capturedUrls.push(def.query());
200
- return "query";
201
- },
202
- };
203
- opts.endpoints(build);
204
- return {
205
- useGetAnnouncementFeedQuery: () => ({
206
- data: [],
207
- error: undefined,
208
- isLoading: false,
209
- refetch: () => Promise.resolve(),
210
- }),
211
- useGetPendingAnnouncementsQuery: () => ({
212
- data: undefined,
213
- error: undefined,
214
- isLoading: false,
215
- refetch: () => Promise.resolve(),
216
- }),
217
- };
218
- },
219
- }),
220
- };
124
+ Platform.OS = "web";
125
+ const {client, calls} = createFakeRequestClient({
126
+ "GET /announcements/feed": () => [],
127
+ "GET /announcements/pending": () => ({current: null, remainingCount: 0}),
128
+ });
129
+ const {result} = renderHook(() => useAnnouncements(client));
130
+ await waitFor(() => expect(result.current.isFeedLoading).toBe(false));
131
+ for (const call of calls) {
132
+ expect(call.params && "version" in call.params).toBe(false);
133
+ }
134
+ expect(calls.find((call) => call.url === "/announcements/feed")?.params).toEqual({
135
+ limit: 20,
136
+ page: 1,
137
+ platform: "web",
138
+ });
139
+ });
221
140
 
222
- renderHook(() => useAnnouncements(api as unknown as AnnouncementsApi, "/api"));
141
+ it("refetches the pending announcement after an acknowledgement", async () => {
142
+ let remainingCount = 1;
143
+ const {client, callsTo} = createFakeRequestClient({
144
+ "GET /announcements/feed": () => [],
145
+ "GET /announcements/pending": () => ({current: null, remainingCount}),
146
+ "POST /announcements/:id/acknowledge": () => ({acknowledged: true}),
147
+ });
148
+ const {result} = renderHook(() => ({
149
+ ack: useAcknowledgeAnnouncement(client),
150
+ announcements: useAnnouncements(client),
151
+ }));
152
+ await waitFor(() => expect(result.current.announcements.pending?.remainingCount).toBe(1));
223
153
 
224
- assert.ok(capturedUrls.every((url) => !url.includes("version=")));
154
+ remainingCount = 0;
155
+ await act(async () => {
156
+ await result.current.ack.acknowledge("announcement-1");
157
+ });
158
+ await waitFor(() => expect(result.current.announcements.pending?.remainingCount).toBe(0));
159
+ expect(callsTo("GET /announcements/pending")).toHaveLength(2);
160
+ expect(callsTo("GET /announcements/feed")).toHaveLength(1);
225
161
  });
226
162
  });
@@ -1,5 +1,7 @@
1
- import {getAnnouncementBuildVersion} from "./announcementBuildVersion";
2
- import {getAnnouncementPlatform} from "./announcementPlatform";
1
+ import {useCallback} from "react";
2
+
3
+ import {buildAnnouncementParams} from "./announcementPlatform";
4
+ import {type TerrenoRequestClient, unwrapDataEnvelope, useClientQuery} from "./requestClient";
3
5
 
4
6
  export type AnnouncementDisplayMode = "banner" | "feed" | "modal";
5
7
 
@@ -23,128 +25,70 @@ export interface PendingAnnouncementsResponse {
23
25
  remainingCount: number;
24
26
  }
25
27
 
26
- interface AnnouncementsResponse<T> {
27
- data?: T;
28
- }
29
-
30
- interface AnnouncementsQueryBuilder {
31
- query: (options: {
32
- providesTags?: string[];
33
- query: (args?: {page?: number; limit?: number}) => string;
34
- }) => unknown;
35
- }
36
-
37
- interface AnnouncementsHookState<T> {
38
- data?: T | AnnouncementsResponse<T>;
28
+ export interface UseAnnouncementsResult {
29
+ /** Error from the pending-announcement request (the feed reports `feedError`). */
39
30
  error: unknown;
31
+ feed: AnnouncementPublic[];
32
+ feedError: unknown;
33
+ isFeedLoading: boolean;
40
34
  isLoading: boolean;
41
- refetch: () => void | Promise<void>;
42
- }
43
-
44
- interface AnnouncementsEnhancedApi {
45
- useGetPendingAnnouncementsQuery: () => AnnouncementsHookState<PendingAnnouncementsResponse>;
46
- useGetAnnouncementFeedQuery: (args?: {
47
- page?: number;
48
- limit?: number;
49
- }) => AnnouncementsHookState<AnnouncementPublic[]>;
50
- }
51
-
52
- interface AnnouncementsApiWithTags {
53
- injectEndpoints: (options: {
54
- endpoints: (build: AnnouncementsQueryBuilder) => {
55
- getAnnouncementFeed: unknown;
56
- getPendingAnnouncements: unknown;
57
- };
58
- overrideExisting: boolean;
59
- }) => AnnouncementsEnhancedApi;
60
- }
61
-
62
- interface AnnouncementsApi {
63
- enhanceEndpoints: (options: {addTagTypes: string[]}) => AnnouncementsApiWithTags;
35
+ isPendingLoading: boolean;
36
+ pending: PendingAnnouncementsResponse | undefined;
37
+ refetch: () => Promise<void>;
38
+ refetchFeed: () => Promise<void>;
64
39
  }
65
40
 
66
- const enhancedApiCache = new WeakMap<AnnouncementsApi, Map<string, AnnouncementsEnhancedApi>>();
67
-
68
- const buildAnnouncementQuerySuffix = (): string => {
69
- const platform = getAnnouncementPlatform();
70
- const version = getAnnouncementBuildVersion();
71
- const versionParam = version === undefined ? "" : `&version=${version}`;
72
- return `platform=${platform}${versionParam}`;
73
- };
74
-
75
- const getEnhancedApi = (api: AnnouncementsApi, base: string): AnnouncementsEnhancedApi => {
76
- let byBase = enhancedApiCache.get(api);
77
- if (!byBase) {
78
- byBase = new Map();
79
- enhancedApiCache.set(api, byBase);
80
- }
81
- const cached = byBase.get(base);
82
- if (cached) {
83
- return cached;
84
- }
85
- const apiWithTags = api.enhanceEndpoints({
86
- addTagTypes: ["PendingAnnouncements", "AnnouncementFeed"],
87
- });
88
- const enhanced = apiWithTags.injectEndpoints({
89
- endpoints: (build) => ({
90
- getAnnouncementFeed: build.query({
91
- providesTags: ["AnnouncementFeed"],
92
- query: (args?: {page?: number; limit?: number}) => {
93
- const page = args?.page ?? 1;
94
- const limit = args?.limit ?? 20;
95
- return `${base}/announcements/feed?page=${page}&limit=${limit}&${buildAnnouncementQuerySuffix()}`;
96
- },
97
- }),
98
- getPendingAnnouncements: build.query({
99
- providesTags: ["PendingAnnouncements"],
100
- query: () => {
101
- return `${base}/announcements/pending?${buildAnnouncementQuerySuffix()}`;
102
- },
103
- }),
104
- }),
105
- overrideExisting: false,
106
- });
107
- byBase.set(base, enhanced);
108
- return enhanced;
109
- };
110
-
41
+ /**
42
+ * Fetch the current pending announcement (`GET /announcements/pending`) and the
43
+ * announcement feed (`GET /announcements/feed`).
44
+ */
111
45
  export const useAnnouncements = (
112
- api: AnnouncementsApi,
46
+ client: TerrenoRequestClient,
113
47
  baseUrl?: string,
114
48
  feedOptions?: {page?: number; limit?: number}
115
- ) => {
49
+ ): UseAnnouncementsResult => {
116
50
  const base = baseUrl || "";
117
- const enhancedApi = getEnhancedApi(api, base);
51
+ const page = feedOptions?.page ?? 1;
52
+ const limit = feedOptions?.limit ?? 20;
53
+
54
+ const fetchPending = useCallback(async (): Promise<PendingAnnouncementsResponse | undefined> => {
55
+ const result = await client.request<unknown>({
56
+ params: buildAnnouncementParams(),
57
+ url: `${base}/announcements/pending`,
58
+ });
59
+ return unwrapDataEnvelope<PendingAnnouncementsResponse>(result);
60
+ }, [base, client]);
61
+
62
+ const fetchFeed = useCallback(async (): Promise<AnnouncementPublic[]> => {
63
+ const result = await client.request<AnnouncementPublic[] | {data?: AnnouncementPublic[]}>({
64
+ params: {limit, page, ...buildAnnouncementParams()},
65
+ url: `${base}/announcements/feed`,
66
+ });
67
+ return Array.isArray(result) ? result : (result?.data ?? []);
68
+ }, [base, client, limit, page]);
69
+
118
70
  const {
119
- data: pendingData,
71
+ data: pending,
72
+ error,
120
73
  isLoading: isPendingLoading,
121
- error: pendingError,
122
- refetch: refetchPending,
123
- } = enhancedApi.useGetPendingAnnouncementsQuery();
74
+ refetch,
75
+ } = useClientQuery({client, fetcher: fetchPending, providesTag: "PendingAnnouncements"});
124
76
  const {
125
- data: feedData,
126
- isLoading: isFeedLoading,
77
+ data: feed,
127
78
  error: feedError,
79
+ isLoading: isFeedLoading,
128
80
  refetch: refetchFeed,
129
- } = enhancedApi.useGetAnnouncementFeedQuery(feedOptions);
130
-
131
- const pendingPayload =
132
- (pendingData as AnnouncementsResponse<PendingAnnouncementsResponse> | undefined)?.data ??
133
- (pendingData as PendingAnnouncementsResponse | undefined);
134
- const feedPayload =
135
- (feedData as AnnouncementsResponse<AnnouncementPublic[]> | undefined)?.data ??
136
- (feedData as AnnouncementPublic[] | undefined) ??
137
- [];
81
+ } = useClientQuery({client, fetcher: fetchFeed});
138
82
 
139
83
  return {
140
- error: pendingError,
141
- feed: feedPayload,
84
+ error,
85
+ feed: feed ?? [],
142
86
  feedError,
143
87
  isFeedLoading,
144
88
  isLoading: isPendingLoading,
145
89
  isPendingLoading,
146
- pending: pendingPayload,
147
- refetch: refetchPending,
90
+ pending,
91
+ refetch,
148
92
  refetchFeed,
149
93
  };
150
94
  };