@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,223 +1,131 @@
1
- import {describe, expect, it, mock} from "bun:test";
2
- import {renderHook} from "@testing-library/react-native";
3
- import {assert} from "chai";
1
+ import {afterEach, describe, expect, it} from "bun:test";
2
+ import {act, renderHook} from "@testing-library/react-native";
3
+ import Constants from "expo-constants";
4
4
  import {Platform} from "react-native";
5
5
 
6
- import {useAcknowledgeAnnouncement} from "./useAcknowledgeAnnouncement";
7
-
8
- type AcknowledgeApi = Parameters<typeof useAcknowledgeAnnouncement>[0];
6
+ // Drive the preload's shared expo-constants mock (src/bunSetup.ts) instead of replacing the
7
+ // module: Bun's mock.module is process-global, so a second registration leaks into siblings.
8
+ const constantsState = Constants as unknown as {
9
+ expoConfig: {extra: {buildNumber?: number | string}};
10
+ };
9
11
 
10
- interface MockMutationDef {
11
- query: (args: {announcementId: string; platform?: string}) => {
12
- body?: {action?: string; platform?: string};
13
- method: string;
14
- url: string;
15
- };
16
- }
12
+ import {createFakeRequestClient, fakeHttpError} from "./test-utils";
13
+ import {useAcknowledgeAnnouncement} from "./useAcknowledgeAnnouncement";
17
14
 
18
- interface MockInjectOpts {
19
- endpoints: (build: {mutation: (def: MockMutationDef) => string}) => Record<string, unknown>;
20
- }
15
+ const buildClient = (): ReturnType<typeof createFakeRequestClient> =>
16
+ createFakeRequestClient({
17
+ "POST /api/announcements/:id/acknowledge": () => ({acknowledged: true}),
18
+ "POST /api/announcements/:id/click": () => ({recorded: true}),
19
+ "POST /api/announcements/:id/impression": () => ({recorded: true}),
20
+ });
21
21
 
22
22
  describe("useAcknowledgeAnnouncement", () => {
23
- const buildApi = () => {
24
- const acknowledgeUnwrap = mock(async () => ({acknowledged: true}));
25
- const impressionUnwrap = mock(async () => ({recorded: true}));
26
- const clickUnwrap = mock(async () => ({recorded: true}));
27
- const acknowledgeMutation = mock(() => ({unwrap: acknowledgeUnwrap}));
28
- const impressionMutation = mock(() => ({unwrap: impressionUnwrap}));
29
- const clickMutation = mock(() => ({unwrap: clickUnwrap}));
30
- let clickQueryDef: MockMutationDef | undefined;
31
- let acknowledgeQueryDef: MockMutationDef | undefined;
32
- const api = {
33
- enhanceEndpoints: mock(() => ({
34
- injectEndpoints: mock((opts: MockInjectOpts) => {
35
- const build = {
36
- mutation: mock((def: MockMutationDef) => {
37
- const result = def.query({announcementId: "a1", platform: "ios"});
38
- expect(result.method).toBe("POST");
39
- expect(result.url).toContain("/announcements/a1/");
40
- if (result.url.includes("/click")) {
41
- clickQueryDef = def;
42
- }
43
- if (result.url.includes("/acknowledge")) {
44
- acknowledgeQueryDef = def;
45
- }
46
- return "mutation";
47
- }),
48
- };
49
- opts.endpoints(build);
50
- return {
51
- useAcknowledgeAnnouncementMutation: () => [
52
- acknowledgeMutation,
53
- {error: undefined, isLoading: false},
54
- ],
55
- useRecordAnnouncementClickMutation: () => [
56
- clickMutation,
57
- {error: undefined, isLoading: false},
58
- ],
59
- useRecordAnnouncementImpressionMutation: () => [
60
- impressionMutation,
61
- {error: undefined, isLoading: false},
62
- ],
63
- };
64
- }),
65
- })),
66
- };
67
- return {
68
- acknowledgeMutation,
69
- acknowledgeQueryDef: () => acknowledgeQueryDef,
70
- api,
71
- clickMutation,
72
- clickQueryDef: () => clickQueryDef,
73
- impressionMutation,
74
- };
75
- };
23
+ const originalOS = Platform.OS;
24
+
25
+ afterEach(() => {
26
+ constantsState.expoConfig.extra.buildNumber = undefined;
27
+ Platform.OS = originalOS;
28
+ });
76
29
 
77
30
  it("acknowledges and records impressions", async () => {
78
- const {api, acknowledgeMutation, impressionMutation} = buildApi();
79
- const {result} = renderHook(() =>
80
- useAcknowledgeAnnouncement(api as unknown as AcknowledgeApi, "/api")
81
- );
82
- await result.current.acknowledge("announcement-1");
83
- await result.current.recordImpression("announcement-1");
84
- expect(acknowledgeMutation).toHaveBeenCalled();
85
- expect(impressionMutation).toHaveBeenCalled();
31
+ const {client, callsTo} = buildClient();
32
+ const {result} = renderHook(() => useAcknowledgeAnnouncement(client, "/api"));
33
+ await act(async () => {
34
+ await result.current.acknowledge("announcement-1");
35
+ await result.current.recordImpression("announcement-1");
36
+ });
37
+ expect(callsTo("POST /api/announcements/announcement-1/acknowledge")).toHaveLength(1);
38
+ expect(callsTo("POST /api/announcements/announcement-1/impression")).toHaveLength(1);
39
+ expect(result.current.isSubmitting).toBe(false);
86
40
  });
87
41
 
88
42
  it("uses the client platform for impressions", async () => {
89
- const originalOS = Platform.OS;
90
43
  Platform.OS = "ios";
91
- const {api, impressionMutation} = buildApi();
92
- const {result} = renderHook(() => useAcknowledgeAnnouncement(api as unknown as AcknowledgeApi));
93
- await result.current.recordImpression("announcement-1");
94
- expect(impressionMutation).toHaveBeenCalledWith({
95
- announcementId: "announcement-1",
96
- platform: "ios",
44
+ const {client, calls} = buildClient();
45
+ const {result} = renderHook(() => useAcknowledgeAnnouncement(client, "/api"));
46
+ await act(async () => {
47
+ await result.current.recordImpression("announcement-1");
97
48
  });
98
- Platform.OS = originalOS;
49
+ expect(calls).toEqual([
50
+ {
51
+ body: {platform: "ios"},
52
+ method: "POST",
53
+ url: "/api/announcements/announcement-1/impression",
54
+ },
55
+ ]);
99
56
  });
100
57
 
101
58
  it("records primary-action clicks with platform and build version in the query", async () => {
102
- const constantsState = {
103
- expoConfig: {
104
- extra: {
105
- buildNumber: 42,
106
- },
107
- },
108
- };
109
- mock.module("expo-constants", () => ({
110
- default: constantsState,
111
- }));
112
-
113
- const originalOS = Platform.OS;
59
+ constantsState.expoConfig.extra.buildNumber = 42;
114
60
  Platform.OS = "web";
115
-
116
- const {api, clickMutation, clickQueryDef} = buildApi();
117
- const {result} = renderHook(() =>
118
- useAcknowledgeAnnouncement(api as unknown as AcknowledgeApi, "/api")
119
- );
120
-
121
- await result.current.recordClick("announcement-42");
122
-
123
- assert.strictEqual(clickMutation.mock.calls.length, 1);
124
- assert.deepEqual(clickMutation.mock.calls[0], [{announcementId: "announcement-42"}]);
125
-
126
- const clickDef = clickQueryDef();
127
- assert.ok(clickDef);
128
- const queryResult = clickDef.query({announcementId: "announcement-42"});
129
- assert.strictEqual(queryResult.method, "POST");
130
- assert.strictEqual(
131
- queryResult.url,
132
- "/api/announcements/announcement-42/click?platform=web&version=42"
133
- );
134
- assert.deepEqual(queryResult.body, {action: "primaryAction", platform: "web"});
135
-
136
- Platform.OS = originalOS;
137
- mock.module("expo-constants", () => ({
138
- default: {expoConfig: {extra: {buildNumber: undefined}}},
139
- }));
61
+ const {client, calls} = buildClient();
62
+ const {result} = renderHook(() => useAcknowledgeAnnouncement(client, "/api"));
63
+ await act(async () => {
64
+ await result.current.recordClick("announcement-42");
65
+ });
66
+ expect(calls).toEqual([
67
+ {
68
+ body: {action: "primaryAction", platform: "web"},
69
+ method: "POST",
70
+ params: {platform: "web", version: 42},
71
+ url: "/api/announcements/announcement-42/click",
72
+ },
73
+ ]);
140
74
  });
141
75
 
142
- it("omits version from click URL when build number is not finite", async () => {
143
- mock.module("expo-constants", () => ({
144
- default: {expoConfig: {extra: {buildNumber: undefined}}},
145
- }));
146
-
147
- const originalOS = Platform.OS;
76
+ it("omits version from click params when build number is not finite", async () => {
148
77
  Platform.OS = "android";
149
-
150
- const {api, clickQueryDef} = buildApi();
151
- renderHook(() => useAcknowledgeAnnouncement(api as unknown as AcknowledgeApi, "/api"));
152
-
153
- const clickDef = clickQueryDef();
154
- assert.ok(clickDef);
155
- const queryResult = clickDef.query({announcementId: "announcement-1"});
156
- assert.strictEqual(queryResult.url, "/api/announcements/announcement-1/click?platform=android");
157
- assert.deepEqual(queryResult.body, {action: "primaryAction", platform: "android"});
158
-
159
- Platform.OS = originalOS;
78
+ const {client, calls} = buildClient();
79
+ const {result} = renderHook(() => useAcknowledgeAnnouncement(client, "/api"));
80
+ await act(async () => {
81
+ await result.current.recordClick("announcement-1");
82
+ });
83
+ expect(calls[0]?.params).toEqual({platform: "android"});
84
+ expect(calls[0]?.body).toEqual({action: "primaryAction", platform: "android"});
160
85
  });
161
86
 
162
87
  it("posts acknowledge with platform and build version in the query", async () => {
163
- const constantsState = {
164
- expoConfig: {
165
- extra: {
166
- buildNumber: 42,
167
- },
168
- },
169
- };
170
- mock.module("expo-constants", () => ({
171
- default: constantsState,
172
- }));
173
-
174
- const originalOS = Platform.OS;
88
+ constantsState.expoConfig.extra.buildNumber = 42;
175
89
  Platform.OS = "ios";
176
-
177
- const {api, acknowledgeMutation, acknowledgeQueryDef} = buildApi();
178
- const {result} = renderHook(() =>
179
- useAcknowledgeAnnouncement(api as unknown as AcknowledgeApi, "/api")
180
- );
181
-
182
- await result.current.acknowledge("announcement-42");
183
-
184
- assert.strictEqual(acknowledgeMutation.mock.calls.length, 1);
185
- assert.deepEqual(acknowledgeMutation.mock.calls[0], [{announcementId: "announcement-42"}]);
186
-
187
- const acknowledgeDef = acknowledgeQueryDef();
188
- assert.ok(acknowledgeDef);
189
- const queryResult = acknowledgeDef.query({announcementId: "announcement-42"});
190
- assert.strictEqual(queryResult.method, "POST");
191
- assert.strictEqual(
192
- queryResult.url,
193
- "/api/announcements/announcement-42/acknowledge?platform=ios&version=42"
194
- );
195
-
196
- Platform.OS = originalOS;
197
- mock.module("expo-constants", () => ({
198
- default: {expoConfig: {extra: {buildNumber: undefined}}},
199
- }));
90
+ const {client, calls} = buildClient();
91
+ const {result} = renderHook(() => useAcknowledgeAnnouncement(client, "/api"));
92
+ await act(async () => {
93
+ await result.current.acknowledge("announcement-42");
94
+ });
95
+ expect(calls).toEqual([
96
+ {
97
+ method: "POST",
98
+ params: {platform: "ios", version: 42},
99
+ url: "/api/announcements/announcement-42/acknowledge",
100
+ },
101
+ ]);
200
102
  });
201
103
 
202
- it("omits version from acknowledge URL when build number is not finite", async () => {
203
- mock.module("expo-constants", () => ({
204
- default: {expoConfig: {extra: {buildNumber: undefined}}},
205
- }));
206
-
207
- const originalOS = Platform.OS;
104
+ it("omits version from acknowledge params when build number is not finite", async () => {
105
+ constantsState.expoConfig.extra.buildNumber = "invalid";
208
106
  Platform.OS = "web";
107
+ const {client, calls} = createFakeRequestClient({
108
+ "POST /announcements/:id/acknowledge": () => ({acknowledged: true}),
109
+ });
110
+ const {result} = renderHook(() => useAcknowledgeAnnouncement(client));
111
+ await act(async () => {
112
+ await result.current.acknowledge("announcement-1");
113
+ });
114
+ expect(calls[0]?.url).toBe("/announcements/announcement-1/acknowledge");
115
+ expect(calls[0]?.params).toEqual({platform: "web"});
116
+ });
209
117
 
210
- const {api, acknowledgeQueryDef} = buildApi();
211
- renderHook(() => useAcknowledgeAnnouncement(api as unknown as AcknowledgeApi, "/api"));
212
-
213
- const acknowledgeDef = acknowledgeQueryDef();
214
- assert.ok(acknowledgeDef);
215
- const queryResult = acknowledgeDef.query({announcementId: "announcement-1"});
216
- assert.strictEqual(
217
- queryResult.url,
218
- "/api/announcements/announcement-1/acknowledge?platform=web"
219
- );
220
-
221
- Platform.OS = originalOS;
118
+ it("exposes the failing request error", async () => {
119
+ const failure = fakeHttpError(500);
120
+ const {client} = createFakeRequestClient({
121
+ "POST /announcements/:id/click": () => {
122
+ throw failure;
123
+ },
124
+ });
125
+ const {result} = renderHook(() => useAcknowledgeAnnouncement(client));
126
+ await act(async () => {
127
+ await result.current.recordClick("announcement-1").catch(() => {});
128
+ });
129
+ expect(result.current.error).toBe(failure);
222
130
  });
223
131
  });
@@ -1,157 +1,79 @@
1
- import {useCallback, useRef} from "react";
1
+ import {useCallback} from "react";
2
2
 
3
- import {getAnnouncementBuildVersion} from "./announcementBuildVersion";
4
- import {getAnnouncementPlatform} from "./announcementPlatform";
3
+ import {buildAnnouncementParams, getAnnouncementPlatform} from "./announcementPlatform";
4
+ import {invalidateClientTags, type TerrenoRequestClient, useClientMutation} from "./requestClient";
5
5
 
6
- interface AcknowledgeAnnouncementMutationResult {
7
- unwrap: () => Promise<unknown>;
8
- }
9
-
10
- interface AcknowledgeAnnouncementMutationHookState {
6
+ export interface UseAcknowledgeAnnouncementResult {
7
+ /** Acknowledge an announcement; the pending announcement refetches on success. */
8
+ acknowledge: (announcementId: string) => Promise<void>;
11
9
  error: unknown;
12
- isLoading: boolean;
13
- }
14
-
15
- interface AcknowledgeAnnouncementMutationBuilder {
16
- mutation: (options: {
17
- invalidatesTags: string[];
18
- query: (args: {announcementId: string; platform?: string}) => {
19
- body?: {action?: string; platform?: string};
20
- method: "POST";
21
- url: string;
22
- };
23
- }) => unknown;
24
- }
25
-
26
- interface AcknowledgeAnnouncementEnhancedApi {
27
- useAcknowledgeAnnouncementMutation: () => [
28
- (args: {announcementId: string; platform?: string}) => AcknowledgeAnnouncementMutationResult,
29
- AcknowledgeAnnouncementMutationHookState,
30
- ];
31
- useRecordAnnouncementClickMutation: () => [
32
- (args: {announcementId: string}) => AcknowledgeAnnouncementMutationResult,
33
- AcknowledgeAnnouncementMutationHookState,
34
- ];
35
- useRecordAnnouncementImpressionMutation: () => [
36
- (args: {announcementId: string; platform?: string}) => AcknowledgeAnnouncementMutationResult,
37
- AcknowledgeAnnouncementMutationHookState,
38
- ];
39
- }
40
-
41
- interface AcknowledgeAnnouncementApiWithTags {
42
- injectEndpoints: (options: {
43
- endpoints: (build: AcknowledgeAnnouncementMutationBuilder) => {
44
- acknowledgeAnnouncement: unknown;
45
- recordAnnouncementClick: unknown;
46
- recordAnnouncementImpression: unknown;
47
- };
48
- overrideExisting: boolean;
49
- }) => AcknowledgeAnnouncementEnhancedApi;
50
- }
51
-
52
- interface AcknowledgeAnnouncementApi {
53
- enhanceEndpoints: (options: {addTagTypes: string[]}) => AcknowledgeAnnouncementApiWithTags;
10
+ isAcknowledging: boolean;
11
+ isRecordingClick: boolean;
12
+ isRecordingImpression: boolean;
13
+ isSubmitting: boolean;
14
+ /** Record a primary-action click. */
15
+ recordClick: (announcementId: string) => Promise<void>;
16
+ /** Record that the announcement was shown (also dismisses non-acknowledgement ones). */
17
+ recordImpression: (announcementId: string) => Promise<void>;
54
18
  }
55
19
 
56
- const enhancedApiCache = new WeakMap<
57
- AcknowledgeAnnouncementApi,
58
- Map<string, AcknowledgeAnnouncementEnhancedApi>
59
- >();
60
-
61
- const buildAnnouncementEventUrl = (
62
- base: string,
63
- announcementId: string,
64
- action: "acknowledge" | "click"
65
- ): string => {
66
- const platform = getAnnouncementPlatform();
67
- const version = getAnnouncementBuildVersion();
68
- const versionParam = version === undefined ? "" : `&version=${version}`;
69
- return `${base}/announcements/${announcementId}/${action}?platform=${platform}${versionParam}`;
70
- };
71
-
72
- const getEnhancedApi = (
73
- api: AcknowledgeAnnouncementApi,
74
- base: string
75
- ): AcknowledgeAnnouncementEnhancedApi => {
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({addTagTypes: ["PendingAnnouncements"]});
86
- const enhanced = apiWithTags.injectEndpoints({
87
- endpoints: (build) => ({
88
- acknowledgeAnnouncement: build.mutation({
89
- invalidatesTags: ["PendingAnnouncements"],
90
- query: ({announcementId}: {announcementId: string}) => ({
91
- method: "POST",
92
- url: buildAnnouncementEventUrl(base, announcementId, "acknowledge"),
93
- }),
94
- }),
95
- recordAnnouncementClick: build.mutation({
96
- invalidatesTags: [],
97
- query: ({announcementId}: {announcementId: string}) => ({
98
- body: {
99
- action: "primaryAction",
100
- platform: getAnnouncementPlatform(),
101
- },
102
- method: "POST",
103
- url: buildAnnouncementEventUrl(base, announcementId, "click"),
104
- }),
105
- }),
106
- recordAnnouncementImpression: build.mutation({
107
- invalidatesTags: [],
108
- query: ({announcementId, platform}: {announcementId: string; platform?: string}) => ({
109
- body: platform ? {platform} : undefined,
110
- method: "POST",
111
- url: `${base}/announcements/${announcementId}/impression`,
112
- }),
113
- }),
114
- }),
115
- overrideExisting: false,
116
- });
117
- byBase.set(base, enhanced);
118
- return enhanced;
119
- };
120
-
121
- export const useAcknowledgeAnnouncement = (api: AcknowledgeAnnouncementApi, baseUrl?: string) => {
20
+ /** Announcement event requests: acknowledge, primary-action click, and impression. */
21
+ export const useAcknowledgeAnnouncement = (
22
+ client: TerrenoRequestClient,
23
+ baseUrl?: string
24
+ ): UseAcknowledgeAnnouncementResult => {
122
25
  const base = baseUrl || "";
123
- const enhancedApi = getEnhancedApi(api, base);
124
-
125
- const [acknowledgeMutation, {isLoading: isAcknowledging, error: acknowledgeError}] =
126
- enhancedApi.useAcknowledgeAnnouncementMutation();
127
- const [clickMutation, {isLoading: isRecordingClick, error: clickError}] =
128
- enhancedApi.useRecordAnnouncementClickMutation();
129
- const [impressionMutation, {isLoading: isRecordingImpression, error: impressionError}] =
130
- enhancedApi.useRecordAnnouncementImpressionMutation();
131
-
132
- const acknowledgeMutationRef = useRef(acknowledgeMutation);
133
- acknowledgeMutationRef.current = acknowledgeMutation;
134
- const clickMutationRef = useRef(clickMutation);
135
- clickMutationRef.current = clickMutation;
136
- const impressionMutationRef = useRef(impressionMutation);
137
- impressionMutationRef.current = impressionMutation;
138
-
139
- const acknowledge = useCallback(async (announcementId: string): Promise<void> => {
140
- await acknowledgeMutationRef.current({announcementId}).unwrap();
141
- }, []);
142
-
143
- const recordClick = useCallback(async (announcementId: string): Promise<void> => {
144
- await clickMutationRef.current({announcementId}).unwrap();
145
- }, []);
146
26
 
147
- const recordImpression = useCallback(async (announcementId: string): Promise<void> => {
148
- await impressionMutationRef
149
- .current({
150
- announcementId,
151
- platform: getAnnouncementPlatform(),
152
- })
153
- .unwrap();
154
- }, []);
27
+ const runAcknowledge = useCallback(
28
+ async (announcementId: string): Promise<void> => {
29
+ await client.request({
30
+ method: "POST",
31
+ params: buildAnnouncementParams(),
32
+ url: `${base}/announcements/${announcementId}/acknowledge`,
33
+ });
34
+ invalidateClientTags({client, tags: ["PendingAnnouncements"]});
35
+ },
36
+ [base, client]
37
+ );
38
+
39
+ const runClick = useCallback(
40
+ async (announcementId: string): Promise<void> => {
41
+ await client.request({
42
+ body: {action: "primaryAction", platform: getAnnouncementPlatform()},
43
+ method: "POST",
44
+ params: buildAnnouncementParams(),
45
+ url: `${base}/announcements/${announcementId}/click`,
46
+ });
47
+ },
48
+ [base, client]
49
+ );
50
+
51
+ const runImpression = useCallback(
52
+ async (announcementId: string): Promise<void> => {
53
+ await client.request({
54
+ body: {platform: getAnnouncementPlatform()},
55
+ method: "POST",
56
+ url: `${base}/announcements/${announcementId}/impression`,
57
+ });
58
+ },
59
+ [base, client]
60
+ );
61
+
62
+ const {
63
+ error: acknowledgeError,
64
+ isLoading: isAcknowledging,
65
+ mutate: acknowledge,
66
+ } = useClientMutation({run: runAcknowledge});
67
+ const {
68
+ error: clickError,
69
+ isLoading: isRecordingClick,
70
+ mutate: recordClick,
71
+ } = useClientMutation({run: runClick});
72
+ const {
73
+ error: impressionError,
74
+ isLoading: isRecordingImpression,
75
+ mutate: recordImpression,
76
+ } = useClientMutation({run: runImpression});
155
77
 
156
78
  return {
157
79
  acknowledge,