@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,6 +1,6 @@
|
|
|
1
1
|
import {afterEach, describe, expect, it, mock} from "bun:test";
|
|
2
|
-
import {renderHook} from "@testing-library/react-native";
|
|
3
|
-
import {
|
|
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 {
|
|
18
|
-
|
|
19
|
-
type
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
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
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
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(
|
|
98
|
-
expect(result.current.
|
|
99
|
-
expect(result.current.
|
|
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("
|
|
104
|
-
const {
|
|
105
|
-
|
|
106
|
-
|
|
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(
|
|
109
|
-
expect(result.current.
|
|
110
|
-
expect(result.current.
|
|
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("
|
|
114
|
-
const {
|
|
115
|
-
|
|
116
|
-
|
|
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(
|
|
119
|
-
expect(result.current.
|
|
120
|
-
expect(result.current.
|
|
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("
|
|
124
|
-
|
|
125
|
-
const
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
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("
|
|
154
|
-
|
|
155
|
-
const
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
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
|
-
|
|
188
|
-
|
|
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
|
-
|
|
194
|
-
const
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
});
|
package/src/useAnnouncements.ts
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
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
|
|
27
|
-
|
|
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
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
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
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
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
|
-
|
|
46
|
+
client: TerrenoRequestClient,
|
|
113
47
|
baseUrl?: string,
|
|
114
48
|
feedOptions?: {page?: number; limit?: number}
|
|
115
|
-
) => {
|
|
49
|
+
): UseAnnouncementsResult => {
|
|
116
50
|
const base = baseUrl || "";
|
|
117
|
-
const
|
|
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:
|
|
71
|
+
data: pending,
|
|
72
|
+
error,
|
|
120
73
|
isLoading: isPendingLoading,
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
} = enhancedApi.useGetPendingAnnouncementsQuery();
|
|
74
|
+
refetch,
|
|
75
|
+
} = useClientQuery({client, fetcher: fetchPending, providesTag: "PendingAnnouncements"});
|
|
124
76
|
const {
|
|
125
|
-
data:
|
|
126
|
-
isLoading: isFeedLoading,
|
|
77
|
+
data: feed,
|
|
127
78
|
error: feedError,
|
|
79
|
+
isLoading: isFeedLoading,
|
|
128
80
|
refetch: refetchFeed,
|
|
129
|
-
} =
|
|
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
|
|
141
|
-
feed:
|
|
84
|
+
error,
|
|
85
|
+
feed: feed ?? [],
|
|
142
86
|
feedError,
|
|
143
87
|
isFeedLoading,
|
|
144
88
|
isLoading: isPendingLoading,
|
|
145
89
|
isPendingLoading,
|
|
146
|
-
pending
|
|
147
|
-
refetch
|
|
90
|
+
pending,
|
|
91
|
+
refetch,
|
|
148
92
|
refetchFeed,
|
|
149
93
|
};
|
|
150
94
|
};
|