@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.
- package/.ai/guidelines/core.md +1 -1
- package/CHANGELOG.md +93 -0
- package/dist/ActionSheet.d.ts +9 -9
- package/dist/ActionSheet.d.ts.map +1 -1
- package/dist/ActionSheet.js +11 -4
- package/dist/ActionSheet.js.map +1 -1
- package/dist/AnnouncementNavigator.d.ts +7 -1
- package/dist/AnnouncementNavigator.d.ts.map +1 -1
- package/dist/AnnouncementNavigator.js +15 -16
- package/dist/AnnouncementNavigator.js.map +1 -1
- package/dist/Avatar.d.ts.map +1 -1
- package/dist/Avatar.js +1 -1
- package/dist/Avatar.js.map +1 -1
- package/dist/Box.d.ts.map +1 -1
- package/dist/Box.js +3 -1
- package/dist/Box.js.map +1 -1
- package/dist/Common.d.ts +71 -39
- package/dist/Common.d.ts.map +1 -1
- package/dist/Common.js.map +1 -1
- package/dist/ConsentFormScreen.d.ts.map +1 -1
- package/dist/ConsentFormScreen.js.map +1 -1
- package/dist/ConsentNavigator.d.ts +5 -3
- package/dist/ConsentNavigator.d.ts.map +1 -1
- package/dist/ConsentNavigator.js +4 -4
- package/dist/ConsentNavigator.js.map +1 -1
- package/dist/CustomSelectField.js.map +1 -1
- package/dist/DataTable.d.ts.map +1 -1
- package/dist/DataTable.js +37 -12
- package/dist/DataTable.js.map +1 -1
- package/dist/DateTimeField.js +6 -6
- package/dist/DateTimeField.js.map +1 -1
- package/dist/DropdownPanel.d.ts +0 -5
- package/dist/DropdownPanel.d.ts.map +1 -1
- package/dist/DropdownPanel.js +0 -5
- package/dist/DropdownPanel.js.map +1 -1
- package/dist/FilterAccordion.d.ts.map +1 -1
- package/dist/FilterAccordion.js.map +1 -1
- package/dist/FilterBoolean.d.ts.map +1 -1
- package/dist/FilterBoolean.js.map +1 -1
- package/dist/FilterSelectMenu.js +1 -1
- package/dist/FilterSelectMenu.js.map +1 -1
- package/dist/GPTChat.d.ts.map +1 -1
- package/dist/GPTChat.js.map +1 -1
- package/dist/Heading.d.ts.map +1 -1
- package/dist/Heading.js +6 -12
- package/dist/Heading.js.map +1 -1
- package/dist/HeightField.d.ts.map +1 -1
- package/dist/HeightField.js +9 -9
- package/dist/HeightField.js.map +1 -1
- package/dist/Hyperlink.d.ts.map +1 -1
- package/dist/Hyperlink.js +6 -1
- package/dist/Hyperlink.js.map +1 -1
- package/dist/Image.d.ts +1 -1
- package/dist/MarkdownEditorField.d.ts.map +1 -1
- package/dist/MarkdownEditorField.js +1 -1
- package/dist/MarkdownEditorField.js.map +1 -1
- package/dist/OfflineBanner.d.ts +3 -2
- package/dist/OfflineBanner.d.ts.map +1 -1
- package/dist/OfflineBanner.js +3 -2
- package/dist/OfflineBanner.js.map +1 -1
- package/dist/OtpField.d.ts.map +1 -1
- package/dist/OtpField.js +4 -4
- package/dist/OtpField.js.map +1 -1
- package/dist/PickerSelect.d.ts +4 -4
- package/dist/PickerSelect.d.ts.map +1 -1
- package/dist/PickerSelect.js +9 -9
- package/dist/PickerSelect.js.map +1 -1
- package/dist/ProvisionalConsentSigner.d.ts +3 -2
- package/dist/ProvisionalConsentSigner.d.ts.map +1 -1
- package/dist/ProvisionalConsentSigner.js +2 -2
- package/dist/ProvisionalConsentSigner.js.map +1 -1
- package/dist/SidebarNavigation.js +2 -2
- package/dist/SidebarNavigation.js.map +1 -1
- package/dist/SidebarNavigation.native.js +2 -2
- package/dist/SidebarNavigation.native.js.map +1 -1
- package/dist/Skeleton.js.map +1 -1
- package/dist/TapToEdit.d.ts +1 -1
- package/dist/TapToEdit.d.ts.map +1 -1
- package/dist/TapToEdit.js.map +1 -1
- package/dist/Text.d.ts.map +1 -1
- package/dist/Text.js +27 -50
- package/dist/Text.js.map +1 -1
- package/dist/TextField.d.ts.map +1 -1
- package/dist/TextField.js +4 -4
- package/dist/TextField.js.map +1 -1
- package/dist/Theme.d.ts.map +1 -1
- package/dist/Theme.js +16 -0
- package/dist/Theme.js.map +1 -1
- package/dist/ThumbsUpDownFeedback.d.ts.map +1 -1
- package/dist/ThumbsUpDownFeedback.js.map +1 -1
- package/dist/ToastNotifications.d.ts.map +1 -1
- package/dist/ToastNotifications.js.map +1 -1
- package/dist/Tooltip.d.ts.map +1 -1
- package/dist/Tooltip.js.map +1 -1
- package/dist/Unifier.d.ts +1 -1
- package/dist/WebAddressAutocomplete.js.map +1 -1
- package/dist/WebDropdownMenu.d.ts +3 -3
- package/dist/WebDropdownMenu.d.ts.map +1 -1
- package/dist/WebDropdownMenu.js +1 -1
- package/dist/WebDropdownMenu.js.map +1 -1
- package/dist/announcementPlatform.d.ts +5 -0
- package/dist/announcementPlatform.d.ts.map +1 -1
- package/dist/announcementPlatform.js +9 -0
- package/dist/announcementPlatform.js.map +1 -1
- package/dist/asks/AskCard.d.ts +2 -2
- package/dist/asks/AskCard.d.ts.map +1 -1
- package/dist/dataTableColumnWidths.d.ts +76 -0
- package/dist/dataTableColumnWidths.d.ts.map +1 -0
- package/dist/dataTableColumnWidths.js +181 -0
- package/dist/dataTableColumnWidths.js.map +1 -0
- package/dist/index.d.ts +2 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/login/LoginScreen.js.map +1 -1
- package/dist/requestClient.d.ts +71 -0
- package/dist/requestClient.d.ts.map +1 -0
- package/dist/requestClient.js +139 -0
- package/dist/requestClient.js.map +1 -0
- package/dist/security/PasswordCard.d.ts.map +1 -1
- package/dist/security/PasswordCard.js.map +1 -1
- package/dist/security/TwoFactorSettingsCard.d.ts.map +1 -1
- package/dist/security/TwoFactorSettingsCard.js +1 -1
- package/dist/security/TwoFactorSettingsCard.js.map +1 -1
- package/dist/signUp/SignUpScreen.js.map +1 -1
- package/dist/table/Table.d.ts.map +1 -1
- package/dist/table/Table.js.map +1 -1
- package/dist/table/TableTitle.d.ts.map +1 -1
- package/dist/table/TableTitle.js +2 -1
- package/dist/table/TableTitle.js.map +1 -1
- package/dist/textFontSizes.d.ts +12 -0
- package/dist/textFontSizes.d.ts.map +1 -0
- package/dist/textFontSizes.js +21 -0
- package/dist/textFontSizes.js.map +1 -0
- package/dist/useAcknowledgeAnnouncement.d.ts +8 -63
- package/dist/useAcknowledgeAnnouncement.d.ts.map +1 -1
- package/dist/useAcknowledgeAnnouncement.js +31 -80
- package/dist/useAcknowledgeAnnouncement.js.map +1 -1
- package/dist/useAnnouncements.d.ts +14 -47
- package/dist/useAnnouncements.d.ts.map +1 -1
- package/dist/useAnnouncements.js +30 -57
- package/dist/useAnnouncements.js.map +1 -1
- package/dist/useConsentForms.d.ts +6 -38
- package/dist/useConsentForms.d.ts.map +1 -1
- package/dist/useConsentForms.js +25 -48
- package/dist/useConsentForms.js.map +1 -1
- package/dist/useProvisionalConsent.d.ts +7 -58
- package/dist/useProvisionalConsent.d.ts.map +1 -1
- package/dist/useProvisionalConsent.js +57 -67
- package/dist/useProvisionalConsent.js.map +1 -1
- package/dist/useSubmitConsent.d.ts +9 -39
- package/dist/useSubmitConsent.d.ts.map +1 -1
- package/dist/useSubmitConsent.js +10 -39
- package/dist/useSubmitConsent.js.map +1 -1
- package/package.json +40 -38
- package/src/ActionSheet.test.tsx +13 -13
- package/src/ActionSheet.tsx +18 -5
- package/src/AddressField.test.tsx +9 -3
- package/src/AnnouncementNavigator.test.tsx +219 -319
- package/src/AnnouncementNavigator.tsx +25 -20
- package/src/Avatar.tsx +2 -9
- package/src/Badge.test.tsx +1 -1
- package/src/Banner.test.tsx +0 -1
- package/src/Box.test.tsx +85 -77
- package/src/Box.tsx +4 -2
- package/src/Button.test.tsx +11 -6
- package/src/Card.test.tsx +2 -2
- package/src/Common.ts +79 -44
- package/src/ConflictSheet.test.tsx +5 -5
- package/src/ConsentFormScreen.test.tsx +3 -1
- package/src/ConsentFormScreen.tsx +2 -1
- package/src/ConsentNavigator.test.tsx +166 -243
- package/src/ConsentNavigator.tsx +9 -13
- package/src/CustomSelectField.test.tsx +16 -4
- package/src/CustomSelectField.tsx +3 -3
- package/src/DataTable.test.tsx +73 -5
- package/src/DataTable.tsx +72 -19
- package/src/DataTableVirtualizationRegression.test.tsx +1 -0
- package/src/DateTimeActionSheet.test.tsx +2 -0
- package/src/DateTimeField.test.tsx +3 -12
- package/src/DateTimeField.tsx +10 -10
- package/src/DismissButton.test.tsx +22 -4
- package/src/DropdownPanel.tsx +0 -6
- package/src/EmailField.test.tsx +13 -22
- package/src/EmojiSelector.test.tsx +2 -2
- package/src/ErrorBoundary.test.tsx +5 -3
- package/src/Field.test.tsx +20 -44
- package/src/FilterAccordion.tsx +3 -3
- package/src/FilterBoolean.tsx +3 -3
- package/src/FilterSelectMenu.tsx +1 -1
- package/src/GPTChat.test.tsx +24 -16
- package/src/GPTChat.tsx +10 -9
- package/src/Heading.test.tsx +1 -1
- package/src/Heading.tsx +7 -14
- package/src/HeightField.tsx +17 -10
- package/src/Hyperlink.tsx +6 -3
- package/src/Icon.test.tsx +2 -2
- package/src/Image.test.tsx +1 -1
- package/src/Link.test.tsx +13 -6
- package/src/MarkdownEditorField.tsx +10 -2
- package/src/MarkdownView.test.tsx +10 -6
- package/src/MobileAddressAutoComplete.test.tsx +2 -1
- package/src/Modal.test.tsx +10 -3
- package/src/ModalSheet.test.tsx +11 -10
- package/src/MultiselectField.test.tsx +17 -3
- package/src/NumberField.test.tsx +14 -14
- package/src/NumberPickerActionSheet.test.tsx +1 -1
- package/src/OfflineBanner.tsx +3 -2
- package/src/OpenAPIContext.test.tsx +4 -4
- package/src/OpenAPIRenderRegression.test.tsx +1 -1
- package/src/OtpField.tsx +6 -5
- package/src/P0RenderRegression.test.tsx +7 -1
- package/src/P1RenderRegression.test.tsx +1 -0
- package/src/P2ButtonRenderRegression.test.tsx +1 -0
- package/src/Page.test.tsx +1 -1
- package/src/PhoneNumberField.test.tsx +14 -38
- package/src/PickerSelect.tsx +12 -11
- package/src/Popover.test.tsx +2 -2
- package/src/ProvisionalConsentSigner.test.tsx +140 -113
- package/src/ProvisionalConsentSigner.tsx +5 -4
- package/src/RadioField.test.tsx +7 -2
- package/src/SegmentedControl.test.tsx +21 -12
- package/src/SidebarNavigation.native.tsx +2 -2
- package/src/SidebarNavigation.test.tsx +18 -6
- package/src/SidebarNavigation.tsx +2 -2
- package/src/Signature.test.tsx +20 -23
- package/src/Skeleton.tsx +1 -1
- package/src/Slider.test.tsx +1 -1
- package/src/SplitPage.test.tsx +15 -5
- package/src/TapToEdit.test.tsx +40 -17
- package/src/TapToEdit.tsx +1 -1
- package/src/TerrenoFontProvider.test.tsx +1 -1
- package/src/Text.test.tsx +4 -4
- package/src/Text.tsx +25 -51
- package/src/TextField.test.tsx +82 -9
- package/src/TextField.tsx +6 -5
- package/src/Theme.test.tsx +49 -0
- package/src/Theme.tsx +16 -0
- package/src/ThumbsUpDownFeedback.tsx +3 -3
- package/src/Toast.test.tsx +5 -5
- package/src/ToastNotifications.test.tsx +73 -70
- package/src/ToastNotifications.tsx +3 -2
- package/src/ToastNotifications.webModal.test.tsx +6 -3
- package/src/Tooltip.test.tsx +3 -3
- package/src/Tooltip.tsx +2 -1
- package/src/UnifiedAddressAutoComplete.test.tsx +1 -1
- package/src/UserInactivity.test.tsx +1 -0
- package/src/WebAddressAutocomplete.test.tsx +12 -12
- package/src/WebAddressAutocomplete.tsx +3 -3
- package/src/WebDropdownMenu.test.tsx +16 -15
- package/src/WebDropdownMenu.tsx +16 -5
- package/src/__snapshots__/Card.test.tsx.snap +1 -1
- package/src/__snapshots__/DataTable.test.tsx.snap +13 -0
- package/src/__snapshots__/DismissButton.test.tsx.snap +3 -3
- package/src/__snapshots__/Field.test.tsx.snap +4 -2
- package/src/__snapshots__/Heading.test.tsx.snap +1 -1
- package/src/__snapshots__/Image.test.tsx.snap +1 -1
- package/src/__snapshots__/Page.test.tsx.snap +2 -2
- package/src/__snapshots__/Text.test.tsx.snap +1 -1
- package/src/announcementPlatform.ts +10 -0
- package/src/asks/AskCard.test.tsx +20 -15
- package/src/asks/AskCard.tsx +2 -2
- package/src/asks/AskFiles.test.tsx +5 -1
- package/src/asks/askFileRefs.test.ts +1 -1
- package/src/asks/askSummary.test.ts +2 -2
- package/src/benchmarks/importTiming.ts +1 -1
- package/src/blocks/BlocksView.test.tsx +20 -11
- package/src/bunSetup.ts +43 -1
- package/src/dataTableColumnWidths.test.ts +266 -0
- package/src/dataTableColumnWidths.ts +272 -0
- package/src/dataTableFilters.test.tsx +1 -1
- package/src/index.tsx +9 -2
- package/src/isolated/ListDetailLayout.isolated.tsx +2 -4
- package/src/login/LoginScreen.test.tsx +6 -6
- package/src/login/LoginScreen.tsx +2 -2
- package/src/requestClient.test.ts +288 -0
- package/src/requestClient.ts +228 -0
- package/src/security/PasswordCard.test.tsx +3 -3
- package/src/security/PasswordCard.tsx +7 -5
- package/src/security/TwoFactorSettingsCard.tsx +10 -3
- package/src/signUp/SignUpScreen.test.tsx +4 -4
- package/src/signUp/SignUpScreen.tsx +2 -2
- package/src/table/Table.tsx +1 -2
- package/src/table/TableTitle.tsx +2 -1
- package/src/table/tableContext.test.tsx +5 -5
- package/src/test-utils.tsx +132 -1
- package/src/testing/reactDomServer.d.ts +7 -0
- package/src/textFontSizes.ts +31 -0
- package/src/useAcknowledgeAnnouncement.test.ts +101 -193
- package/src/useAcknowledgeAnnouncement.ts +69 -147
- package/src/useAnnouncements.test.ts +122 -186
- package/src/useAnnouncements.ts +49 -105
- package/src/useConsentForms.test.ts +59 -112
- package/src/useConsentForms.ts +37 -87
- package/src/useProvisionalConsent.test.ts +74 -150
- package/src/useProvisionalConsent.ts +79 -125
- package/src/useSubmitConsent.test.ts +59 -85
- package/src/useSubmitConsent.ts +22 -77
|
@@ -1,223 +1,131 @@
|
|
|
1
|
-
import {describe, expect, it
|
|
2
|
-
import {renderHook} from "@testing-library/react-native";
|
|
3
|
-
import
|
|
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
|
-
|
|
7
|
-
|
|
8
|
-
|
|
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
|
-
|
|
11
|
-
|
|
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
|
-
|
|
19
|
-
|
|
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
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
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 {
|
|
79
|
-
const {result} = renderHook(() =>
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
expect(
|
|
85
|
-
expect(
|
|
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 {
|
|
92
|
-
const {result} = renderHook(() => useAcknowledgeAnnouncement(api
|
|
93
|
-
await
|
|
94
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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 {
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
);
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
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
|
|
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 {
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
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
|
-
|
|
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 {
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
);
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
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
|
|
203
|
-
|
|
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
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
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
|
|
1
|
+
import {useCallback} from "react";
|
|
2
2
|
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
3
|
+
import {buildAnnouncementParams, getAnnouncementPlatform} from "./announcementPlatform";
|
|
4
|
+
import {invalidateClientTags, type TerrenoRequestClient, useClientMutation} from "./requestClient";
|
|
5
5
|
|
|
6
|
-
interface
|
|
7
|
-
|
|
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
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
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
|
-
|
|
57
|
-
|
|
58
|
-
|
|
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
|
|
148
|
-
|
|
149
|
-
.
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
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,
|