@terreno/ui 57.18.0 → 57.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.ai/guidelines/core.md +1 -1
- package/CHANGELOG.md +2074 -0
- package/dist/Accordion.d.ts.map +1 -1
- package/dist/Accordion.js +3 -3
- package/dist/Accordion.js.map +1 -1
- package/dist/AreaChart.d.ts.map +1 -1
- package/dist/AreaChart.js +2 -2
- package/dist/AreaChart.js.map +1 -1
- package/dist/Avatar.d.ts.map +1 -1
- package/dist/Avatar.js +3 -1
- package/dist/Avatar.js.map +1 -1
- package/dist/BarChart.d.ts.map +1 -1
- package/dist/BarChart.js +2 -2
- package/dist/BarChart.js.map +1 -1
- package/dist/Box.d.ts.map +1 -1
- package/dist/Box.js +66 -8
- package/dist/Box.js.map +1 -1
- package/dist/Card.d.ts.map +1 -1
- package/dist/Card.js +5 -4
- package/dist/Card.js.map +1 -1
- package/dist/ChartCard.d.ts.map +1 -1
- package/dist/ChartCard.js +4 -2
- package/dist/ChartCard.js.map +1 -1
- package/dist/Common.d.ts +240 -14
- package/dist/Common.d.ts.map +1 -1
- package/dist/Common.js.map +1 -1
- package/dist/ConsentFormScreen.d.ts +1 -1
- package/dist/ConsentFormScreen.d.ts.map +1 -1
- package/dist/ConsentFormScreen.js +13 -4
- package/dist/ConsentFormScreen.js.map +1 -1
- package/dist/DateTimeField.d.ts.map +1 -1
- package/dist/DateTimeField.js +5 -3
- package/dist/DateTimeField.js.map +1 -1
- package/dist/DonutChart.d.ts.map +1 -1
- package/dist/DonutChart.js +2 -2
- package/dist/DonutChart.js.map +1 -1
- package/dist/Field.d.ts.map +1 -1
- package/dist/Field.js +2 -0
- package/dist/Field.js.map +1 -1
- package/dist/FormContainer.d.ts +68 -0
- package/dist/FormContainer.d.ts.map +1 -0
- package/dist/FormContainer.js +79 -0
- package/dist/FormContainer.js.map +1 -0
- package/dist/GPTChat.d.ts.map +1 -1
- package/dist/GPTChat.js +2 -1
- package/dist/GPTChat.js.map +1 -1
- package/dist/Heading.d.ts +1 -1
- package/dist/Heading.d.ts.map +1 -1
- package/dist/Heading.js +5 -2
- package/dist/Heading.js.map +1 -1
- package/dist/Icon.d.ts +4 -0
- package/dist/Icon.d.ts.map +1 -1
- package/dist/Icon.js +43 -2
- package/dist/Icon.js.map +1 -1
- package/dist/LabeledCheckBox.d.ts +22 -0
- package/dist/LabeledCheckBox.d.ts.map +1 -0
- package/dist/LabeledCheckBox.js +30 -0
- package/dist/LabeledCheckBox.js.map +1 -0
- package/dist/LineChart.d.ts.map +1 -1
- package/dist/LineChart.js +2 -2
- package/dist/LineChart.js.map +1 -1
- package/dist/ListDetailLayout.d.ts +36 -0
- package/dist/ListDetailLayout.d.ts.map +1 -0
- package/dist/ListDetailLayout.js +153 -0
- package/dist/ListDetailLayout.js.map +1 -0
- package/dist/MarkdownEditor.d.ts.map +1 -1
- package/dist/MarkdownEditor.js +2 -1
- package/dist/MarkdownEditor.js.map +1 -1
- package/dist/MediaQuery.d.ts +1 -1
- package/dist/MediaQuery.d.ts.map +1 -1
- package/dist/MediaQuery.js +1 -1
- package/dist/MediaQuery.js.map +1 -1
- package/dist/OtpField.d.ts +60 -0
- package/dist/OtpField.d.ts.map +1 -0
- package/dist/OtpField.js +154 -0
- package/dist/OtpField.js.map +1 -0
- package/dist/Page.d.ts +1 -0
- package/dist/Page.d.ts.map +1 -1
- package/dist/Page.js +10 -1
- package/dist/Page.js.map +1 -1
- package/dist/ProvisionalConsentSigner.d.ts +21 -0
- package/dist/ProvisionalConsentSigner.d.ts.map +1 -0
- package/dist/ProvisionalConsentSigner.js +199 -0
- package/dist/ProvisionalConsentSigner.js.map +1 -0
- package/dist/ResponsiveBreakpoint.d.ts +5 -0
- package/dist/ResponsiveBreakpoint.d.ts.map +1 -1
- package/dist/ResponsiveBreakpoint.js +7 -0
- package/dist/ResponsiveBreakpoint.js.map +1 -1
- package/dist/Scorecard.d.ts.map +1 -1
- package/dist/Scorecard.js +5 -2
- package/dist/Scorecard.js.map +1 -1
- package/dist/Skeleton.d.ts +39 -0
- package/dist/Skeleton.d.ts.map +1 -0
- package/dist/Skeleton.js +195 -0
- package/dist/Skeleton.js.map +1 -0
- package/dist/SocialLoginButton.d.ts +10 -0
- package/dist/SocialLoginButton.d.ts.map +1 -1
- package/dist/SocialLoginButton.js +26 -8
- package/dist/SocialLoginButton.js.map +1 -1
- package/dist/SplitPage.d.ts +12 -1
- package/dist/SplitPage.d.ts.map +1 -1
- package/dist/SplitPage.js +14 -7
- package/dist/SplitPage.js.map +1 -1
- package/dist/SplitPage.native.d.ts +1 -1
- package/dist/SplitPage.native.d.ts.map +1 -1
- package/dist/SplitPage.native.js +6 -3
- package/dist/SplitPage.native.js.map +1 -1
- package/dist/SplitPageLoading.d.ts +14 -0
- package/dist/SplitPageLoading.d.ts.map +1 -0
- package/dist/SplitPageLoading.js +19 -0
- package/dist/SplitPageLoading.js.map +1 -0
- package/dist/SyncStatusBanner.d.ts +7 -1
- package/dist/SyncStatusBanner.d.ts.map +1 -1
- package/dist/SyncStatusBanner.js +20 -4
- package/dist/SyncStatusBanner.js.map +1 -1
- package/dist/Text.d.ts +3 -1
- package/dist/Text.d.ts.map +1 -1
- package/dist/Text.js +2 -0
- package/dist/Text.js.map +1 -1
- package/dist/TextField.d.ts.map +1 -1
- package/dist/TextField.js +44 -10
- package/dist/TextField.js.map +1 -1
- package/dist/charts/ChartFrame.d.ts +2 -2
- package/dist/charts/ChartFrame.d.ts.map +1 -1
- package/dist/charts/ChartFrame.js +9 -2
- package/dist/charts/ChartFrame.js.map +1 -1
- package/dist/fieldElements/FieldError.d.ts.map +1 -1
- package/dist/fieldElements/FieldError.js +1 -1
- package/dist/fieldElements/FieldError.js.map +1 -1
- package/dist/index.d.ts +21 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +16 -1
- package/dist/index.js.map +1 -1
- package/dist/lazyBoundaries/heavyOptionalExports.d.ts +3 -0
- package/dist/lazyBoundaries/heavyOptionalExports.d.ts.map +1 -1
- package/dist/lazyBoundaries/heavyOptionalExports.js +2 -0
- package/dist/lazyBoundaries/heavyOptionalExports.js.map +1 -1
- package/dist/login/LastUsedBadge.d.ts +14 -0
- package/dist/login/LastUsedBadge.d.ts.map +1 -0
- package/dist/login/LastUsedBadge.js +23 -0
- package/dist/login/LastUsedBadge.js.map +1 -0
- package/dist/login/LoginAccountCard.d.ts +38 -0
- package/dist/login/LoginAccountCard.d.ts.map +1 -0
- package/dist/login/LoginAccountCard.js +72 -0
- package/dist/login/LoginAccountCard.js.map +1 -0
- package/dist/login/LoginAccountList.d.ts +33 -0
- package/dist/login/LoginAccountList.d.ts.map +1 -0
- package/dist/login/LoginAccountList.js +30 -0
- package/dist/login/LoginAccountList.js.map +1 -0
- package/dist/login/LoginScreen.d.ts +4 -4
- package/dist/login/LoginScreen.d.ts.map +1 -1
- package/dist/login/LoginScreen.js +294 -13
- package/dist/login/LoginScreen.js.map +1 -1
- package/dist/login/OutlinePill.d.ts +28 -0
- package/dist/login/OutlinePill.d.ts.map +1 -0
- package/dist/login/OutlinePill.js +48 -0
- package/dist/login/OutlinePill.js.map +1 -0
- package/dist/login/TwoFactorChallengeScreen.d.ts +26 -0
- package/dist/login/TwoFactorChallengeScreen.d.ts.map +1 -0
- package/dist/login/TwoFactorChallengeScreen.js +139 -0
- package/dist/login/TwoFactorChallengeScreen.js.map +1 -0
- package/dist/login/loginMethods.d.ts +27 -0
- package/dist/login/loginMethods.d.ts.map +1 -0
- package/dist/login/loginMethods.js +37 -0
- package/dist/login/loginMethods.js.map +1 -0
- package/dist/login/loginTypes.d.ts +202 -5
- package/dist/login/loginTypes.d.ts.map +1 -1
- package/dist/pdfHtmlTemplate.d.ts +17 -0
- package/dist/pdfHtmlTemplate.d.ts.map +1 -1
- package/dist/pdfHtmlTemplate.js +78 -0
- package/dist/pdfHtmlTemplate.js.map +1 -1
- package/dist/security/AccountSecurityScreen.d.ts +10 -0
- package/dist/security/AccountSecurityScreen.d.ts.map +1 -0
- package/dist/security/AccountSecurityScreen.js +50 -0
- package/dist/security/AccountSecurityScreen.js.map +1 -0
- package/dist/security/LinkedAccountsCard.d.ts +32 -0
- package/dist/security/LinkedAccountsCard.d.ts.map +1 -0
- package/dist/security/LinkedAccountsCard.js +145 -0
- package/dist/security/LinkedAccountsCard.js.map +1 -0
- package/dist/security/PasskeysCard.d.ts +39 -0
- package/dist/security/PasskeysCard.d.ts.map +1 -0
- package/dist/security/PasskeysCard.js +168 -0
- package/dist/security/PasskeysCard.js.map +1 -0
- package/dist/security/PasswordCard.d.ts +32 -0
- package/dist/security/PasswordCard.d.ts.map +1 -0
- package/dist/security/PasswordCard.js +198 -0
- package/dist/security/PasswordCard.js.map +1 -0
- package/dist/security/SessionsCard.d.ts +39 -0
- package/dist/security/SessionsCard.d.ts.map +1 -0
- package/dist/security/SessionsCard.js +168 -0
- package/dist/security/SessionsCard.js.map +1 -0
- package/dist/security/TwoFactorSettingsCard.d.ts +55 -0
- package/dist/security/TwoFactorSettingsCard.d.ts.map +1 -0
- package/dist/security/TwoFactorSettingsCard.js +458 -0
- package/dist/security/TwoFactorSettingsCard.js.map +1 -0
- package/dist/security/securityMethods.d.ts +40 -0
- package/dist/security/securityMethods.d.ts.map +1 -0
- package/dist/security/securityMethods.js +66 -0
- package/dist/security/securityMethods.js.map +1 -0
- package/dist/security/securityTypes.d.ts +467 -0
- package/dist/security/securityTypes.d.ts.map +1 -0
- package/dist/security/securityTypes.js +2 -0
- package/dist/security/securityTypes.js.map +1 -0
- package/dist/security/userAgent.d.ts +26 -0
- package/dist/security/userAgent.d.ts.map +1 -0
- package/dist/security/userAgent.js +80 -0
- package/dist/security/userAgent.js.map +1 -0
- package/dist/signUp/OAuthButtons.d.ts +28 -5
- package/dist/signUp/OAuthButtons.d.ts.map +1 -1
- package/dist/signUp/OAuthButtons.js +44 -5
- package/dist/signUp/OAuthButtons.js.map +1 -1
- package/dist/signUp/SignUpScreen.d.ts.map +1 -1
- package/dist/signUp/SignUpScreen.js +50 -5
- package/dist/signUp/SignUpScreen.js.map +1 -1
- package/dist/signUp/signUpTypes.d.ts +21 -1
- package/dist/signUp/signUpTypes.d.ts.map +1 -1
- package/dist/useConsentForms.d.ts +9 -0
- package/dist/useConsentForms.d.ts.map +1 -1
- package/dist/useConsentForms.js +18 -0
- package/dist/useConsentForms.js.map +1 -1
- package/dist/useProvisionalConsent.d.ts +124 -0
- package/dist/useProvisionalConsent.d.ts.map +1 -0
- package/dist/useProvisionalConsent.js +79 -0
- package/dist/useProvisionalConsent.js.map +1 -0
- package/dist/withLoading.d.ts +20 -0
- package/dist/withLoading.d.ts.map +1 -0
- package/dist/withLoading.js +24 -0
- package/dist/withLoading.js.map +1 -0
- package/package.json +4 -2
- package/src/Accordion.test.tsx +5 -0
- package/src/Accordion.tsx +3 -8
- package/src/AreaChart.test.tsx +15 -0
- package/src/AreaChart.tsx +6 -0
- package/src/Avatar.test.tsx +8 -0
- package/src/Avatar.tsx +2 -0
- package/src/BarChart.test.tsx +15 -0
- package/src/BarChart.tsx +6 -0
- package/src/Box.test.tsx +131 -1
- package/src/Box.tsx +77 -8
- package/src/Card.test.tsx +48 -0
- package/src/Card.tsx +13 -2
- package/src/ChartCard.test.tsx +30 -0
- package/src/ChartCard.tsx +18 -1
- package/src/Common.ts +263 -14
- package/src/ConsentFormScreen.test.tsx +84 -0
- package/src/ConsentFormScreen.tsx +28 -4
- package/src/DateTimeField.tsx +5 -3
- package/src/DonutChart.test.tsx +15 -0
- package/src/DonutChart.tsx +6 -0
- package/src/Field.tsx +2 -0
- package/src/FilePickerButton.test.tsx +35 -0
- package/src/FormContainer.test.tsx +242 -0
- package/src/FormContainer.tsx +177 -0
- package/src/GPTChat.test.tsx +16 -0
- package/src/GPTChat.tsx +8 -2
- package/src/Heading.test.tsx +14 -0
- package/src/Heading.tsx +6 -1
- package/src/Icon.test.tsx +52 -1
- package/src/Icon.tsx +92 -3
- package/src/IconButton.test.tsx +85 -0
- package/src/LabeledCheckBox.test.tsx +45 -0
- package/src/LabeledCheckBox.tsx +89 -0
- package/src/LineChart.test.tsx +18 -0
- package/src/LineChart.tsx +6 -0
- package/src/ListDetailLayout.tsx +247 -0
- package/src/MarkdownEditor.tsx +2 -1
- package/src/MediaQuery.ts +1 -0
- package/src/OtpField.test.tsx +280 -0
- package/src/OtpField.tsx +307 -0
- package/src/Page.test.tsx +38 -0
- package/src/Page.tsx +38 -19
- package/src/ProvisionalConsentSigner.test.tsx +625 -0
- package/src/ProvisionalConsentSigner.tsx +423 -0
- package/src/ResponsiveBreakpoint.test.tsx +7 -0
- package/src/ResponsiveBreakpoint.tsx +14 -0
- package/src/RootImportRegression.test.tsx +3 -0
- package/src/Scorecard.test.tsx +11 -0
- package/src/Scorecard.tsx +21 -0
- package/src/Skeleton.test.tsx +262 -0
- package/src/Skeleton.tsx +430 -0
- package/src/SocialLoginButton.test.tsx +14 -0
- package/src/SocialLoginButton.tsx +51 -7
- package/src/SplitPage.native.tsx +16 -3
- package/src/SplitPage.tsx +29 -12
- package/src/SplitPageLoading.test.tsx +51 -0
- package/src/SplitPageLoading.tsx +53 -0
- package/src/SyncStatusBanner.test.tsx +61 -4
- package/src/SyncStatusBanner.tsx +29 -3
- package/src/Text.tsx +4 -1
- package/src/TextField.test.tsx +150 -0
- package/src/TextField.tsx +66 -8
- package/src/__snapshots__/AddressField.test.tsx.snap +12 -0
- package/src/__snapshots__/AiSuggestionBox.test.tsx.snap +15 -0
- package/src/__snapshots__/Avatar.test.tsx.snap +1 -0
- package/src/__snapshots__/CustomSelectField.test.tsx.snap +3 -0
- package/src/__snapshots__/EmailField.test.tsx.snap +6 -0
- package/src/__snapshots__/Field.test.tsx.snap +37 -0
- package/src/__snapshots__/HeightField.test.tsx.snap +2 -0
- package/src/__snapshots__/MobileAddressAutoComplete.test.tsx.snap +3 -0
- package/src/__snapshots__/NumberField.test.tsx.snap +3 -0
- package/src/__snapshots__/Page.test.tsx.snap +28 -5
- package/src/__snapshots__/PhoneNumberField.test.tsx.snap +12 -0
- package/src/__snapshots__/Slider.test.tsx.snap +1 -0
- package/src/__snapshots__/SocialLoginButton.test.tsx.snap +43 -22
- package/src/__snapshots__/SplitPage.test.tsx.snap +16 -0
- package/src/__snapshots__/TapToEdit.test.tsx.snap +3 -0
- package/src/__snapshots__/TextArea.test.tsx.snap +17 -1
- package/src/__snapshots__/TextField.test.tsx.snap +19 -2
- package/src/__snapshots__/TypedSignatureField.test.tsx.snap +3 -0
- package/src/__snapshots__/UnifiedAddressAutoComplete.test.tsx.snap +18 -0
- package/src/__snapshots__/WebAddressAutocomplete.test.tsx.snap +12 -0
- package/src/bunSetup.ts +13 -1
- package/src/charts/ChartFrame.tsx +19 -8
- package/src/fieldElements/FieldError.tsx +1 -0
- package/src/fieldElements/__snapshots__/FieldError.test.tsx.snap +2 -0
- package/src/index.tsx +44 -1
- package/src/isolated/ListDetailLayout.isolated.tsx +634 -0
- package/src/lazyBoundaries/heavyOptionalExports.tsx +7 -0
- package/src/login/LastUsedBadge.tsx +40 -0
- package/src/login/LoginAccountCard.tsx +205 -0
- package/src/login/LoginAccountList.tsx +115 -0
- package/src/login/LoginScreen.test.tsx +837 -1
- package/src/login/LoginScreen.tsx +674 -91
- package/src/login/OutlinePill.tsx +110 -0
- package/src/login/TwoFactorChallengeScreen.test.tsx +376 -0
- package/src/login/TwoFactorChallengeScreen.tsx +307 -0
- package/src/login/__snapshots__/LoginScreen.test.tsx.snap +1454 -334
- package/src/login/loginMethods.test.ts +53 -0
- package/src/login/loginMethods.ts +60 -0
- package/src/login/loginTypes.ts +208 -5
- package/src/pdfHtmlTemplate.test.ts +243 -4
- package/src/pdfHtmlTemplate.ts +93 -0
- package/src/security/AccountSecurityScreen.test.tsx +262 -0
- package/src/security/AccountSecurityScreen.tsx +156 -0
- package/src/security/LinkedAccountsCard.test.tsx +371 -0
- package/src/security/LinkedAccountsCard.tsx +297 -0
- package/src/security/PasskeysCard.test.tsx +378 -0
- package/src/security/PasskeysCard.tsx +371 -0
- package/src/security/PasswordCard.test.tsx +445 -0
- package/src/security/PasswordCard.tsx +342 -0
- package/src/security/SessionsCard.test.tsx +349 -0
- package/src/security/SessionsCard.tsx +362 -0
- package/src/security/TwoFactorSettingsCard.test.tsx +700 -0
- package/src/security/TwoFactorSettingsCard.tsx +872 -0
- package/src/security/securityMethods.test.ts +101 -0
- package/src/security/securityMethods.ts +104 -0
- package/src/security/securityTypes.ts +480 -0
- package/src/security/userAgent.test.ts +119 -0
- package/src/security/userAgent.ts +102 -0
- package/src/signUp/OAuthButtons.test.tsx +27 -0
- package/src/signUp/OAuthButtons.tsx +153 -19
- package/src/signUp/SignUpScreen.test.tsx +170 -1
- package/src/signUp/SignUpScreen.tsx +87 -25
- package/src/signUp/__snapshots__/SignUpScreen.test.tsx.snap +22 -11
- package/src/signUp/signUpTypes.ts +23 -1
- package/src/useConsentForms.test.ts +37 -1
- package/src/useConsentForms.ts +25 -0
- package/src/useProvisionalConsent.test.ts +256 -0
- package/src/useProvisionalConsent.ts +218 -0
- package/src/withLoading.test.tsx +61 -0
- package/src/withLoading.tsx +50 -0
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
import {useCallback} from "react";
|
|
2
|
+
|
|
3
|
+
import type {ConsentFormPublic} from "./useConsentForms";
|
|
4
|
+
|
|
5
|
+
export type ProvisionalConsentStatus = "pending" | "provisional" | "signed" | "declined";
|
|
6
|
+
|
|
7
|
+
export interface ProvisionalConsentSignedBy {
|
|
8
|
+
id: string;
|
|
9
|
+
name?: string;
|
|
10
|
+
email?: string;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/** Label for whoever signed provisionally: their name, then their email, then "Staff". */
|
|
14
|
+
export const provisionalSignerName = (
|
|
15
|
+
signer?: {name?: string; email?: string} | string | null
|
|
16
|
+
): string => {
|
|
17
|
+
if (!signer || typeof signer !== "object") {
|
|
18
|
+
return "Staff";
|
|
19
|
+
}
|
|
20
|
+
return signer.name || signer.email || "Staff";
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
/** One row of `GET /consent-responses/status`: a form and where the user stands on it. */
|
|
24
|
+
export interface ProvisionalConsentStatusRow {
|
|
25
|
+
form: ConsentFormPublic & {_id?: string};
|
|
26
|
+
status: ProvisionalConsentStatus;
|
|
27
|
+
/** True for `signed` and `provisional`. */
|
|
28
|
+
isConsented: boolean;
|
|
29
|
+
respondedAt?: string;
|
|
30
|
+
provisional?: {
|
|
31
|
+
responseId: string;
|
|
32
|
+
signedAt: string;
|
|
33
|
+
signedBy: ProvisionalConsentSignedBy | null;
|
|
34
|
+
note?: string;
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
interface ConsentStatusResponse {
|
|
39
|
+
data?: ProvisionalConsentStatusRow[];
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export interface SignConsentProvisionallyBody {
|
|
43
|
+
userId: string;
|
|
44
|
+
consentFormId: string;
|
|
45
|
+
note: string;
|
|
46
|
+
locale?: string;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/** The `ConsentResponse` the server returns for a provisional signature. */
|
|
50
|
+
export interface ProvisionalConsentResponse {
|
|
51
|
+
_id: string;
|
|
52
|
+
agreedAt: string;
|
|
53
|
+
consentFormId: string;
|
|
54
|
+
userId: string;
|
|
55
|
+
provisional: boolean;
|
|
56
|
+
provisionalNote?: string;
|
|
57
|
+
provisionalSignedBy?: {_id: string; name?: string; email?: string} | string;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
type MutationTrigger<TBody> = (body: TBody) => {unwrap: () => Promise<unknown>};
|
|
61
|
+
|
|
62
|
+
type MutationHook<TBody> = () => [MutationTrigger<TBody>, {isLoading: boolean; error?: unknown}];
|
|
63
|
+
|
|
64
|
+
export interface VoidProvisionalConsentArgs {
|
|
65
|
+
responseId: string;
|
|
66
|
+
reason: string;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
interface ProvisionalConsentQueryBuilder {
|
|
70
|
+
query: (options: {providesTags: string[]; query: (userId: string) => string}) => unknown;
|
|
71
|
+
mutation: <TArgs>(options: {
|
|
72
|
+
invalidatesTags: string[];
|
|
73
|
+
query: (args: TArgs) => {body: unknown; method: "POST"; url: string};
|
|
74
|
+
}) => unknown;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
interface ProvisionalConsentQueryState {
|
|
78
|
+
data?: ProvisionalConsentStatusRow[] | ConsentStatusResponse;
|
|
79
|
+
error: unknown;
|
|
80
|
+
isLoading: boolean;
|
|
81
|
+
refetch: () => void | Promise<void>;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
interface ProvisionalConsentEnhancedApi {
|
|
85
|
+
useGetConsentStatusQuery: (userId: string) => ProvisionalConsentQueryState;
|
|
86
|
+
useSignConsentProvisionallyMutation: MutationHook<SignConsentProvisionallyBody>;
|
|
87
|
+
useVoidProvisionalConsentMutation: MutationHook<VoidProvisionalConsentArgs>;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
interface ProvisionalConsentApiWithTags {
|
|
91
|
+
injectEndpoints: (options: {
|
|
92
|
+
endpoints: (build: ProvisionalConsentQueryBuilder) => {
|
|
93
|
+
getConsentStatus: unknown;
|
|
94
|
+
signConsentProvisionally: unknown;
|
|
95
|
+
voidProvisionalConsent: unknown;
|
|
96
|
+
};
|
|
97
|
+
overrideExisting: boolean;
|
|
98
|
+
}) => ProvisionalConsentEnhancedApi;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
/** The consumer's RTK Query api, as passed to `ConsentNavigator`. */
|
|
102
|
+
export interface ProvisionalConsentApi {
|
|
103
|
+
enhanceEndpoints: (options: {addTagTypes: string[]}) => ProvisionalConsentApiWithTags;
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
export interface UseProvisionalConsentResult {
|
|
107
|
+
statuses: ProvisionalConsentStatusRow[];
|
|
108
|
+
isLoading: boolean;
|
|
109
|
+
error: unknown;
|
|
110
|
+
refetch: () => void | Promise<void>;
|
|
111
|
+
/** Sign a form provisionally for the user. Rejects with the RTK error on failure. */
|
|
112
|
+
sign: (body: Omit<SignConsentProvisionallyBody, "userId">) => Promise<ProvisionalConsentResponse>;
|
|
113
|
+
isSigning: boolean;
|
|
114
|
+
/** Void a provisional signature made in error. Rejects with the RTK error on failure. */
|
|
115
|
+
voidSignature: (args: VoidProvisionalConsentArgs) => Promise<ProvisionalConsentResponse>;
|
|
116
|
+
isVoiding: boolean;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
/** Mutations may arrive as `{data}` envelopes or already unwrapped by the base query. */
|
|
120
|
+
const unwrapData = <T>(result: unknown): T => {
|
|
121
|
+
if (result && typeof result === "object" && "data" in result) {
|
|
122
|
+
return (result as {data: T}).data;
|
|
123
|
+
}
|
|
124
|
+
return result as T;
|
|
125
|
+
};
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* Cache the enhanced api per (api, baseUrl) so `injectEndpoints` runs once, as in
|
|
129
|
+
* `useConsentForms`: re-injecting the same endpoint name logs a development error.
|
|
130
|
+
*/
|
|
131
|
+
const enhancedApiCache = new WeakMap<
|
|
132
|
+
ProvisionalConsentApi,
|
|
133
|
+
Map<string, ProvisionalConsentEnhancedApi>
|
|
134
|
+
>();
|
|
135
|
+
|
|
136
|
+
const getEnhancedApi = (
|
|
137
|
+
api: ProvisionalConsentApi,
|
|
138
|
+
base: string
|
|
139
|
+
): ProvisionalConsentEnhancedApi => {
|
|
140
|
+
let byBase = enhancedApiCache.get(api);
|
|
141
|
+
if (!byBase) {
|
|
142
|
+
byBase = new Map();
|
|
143
|
+
enhancedApiCache.set(api, byBase);
|
|
144
|
+
}
|
|
145
|
+
const cached = byBase.get(base);
|
|
146
|
+
if (cached) {
|
|
147
|
+
return cached;
|
|
148
|
+
}
|
|
149
|
+
const apiWithTags = api.enhanceEndpoints({addTagTypes: ["ConsentStatus", "PendingConsents"]});
|
|
150
|
+
const enhanced = apiWithTags.injectEndpoints({
|
|
151
|
+
endpoints: (build) => ({
|
|
152
|
+
getConsentStatus: build.query({
|
|
153
|
+
providesTags: ["ConsentStatus"],
|
|
154
|
+
query: (userId: string) =>
|
|
155
|
+
`${base}/consent-responses/status?userId=${encodeURIComponent(userId)}`,
|
|
156
|
+
}),
|
|
157
|
+
// A provisional signature changes the target's statuses and their pending notice.
|
|
158
|
+
signConsentProvisionally: build.mutation<SignConsentProvisionallyBody>({
|
|
159
|
+
invalidatesTags: ["ConsentStatus", "PendingConsents"],
|
|
160
|
+
query: (body) => ({
|
|
161
|
+
body,
|
|
162
|
+
method: "POST",
|
|
163
|
+
url: `${base}/consent-responses/provisional`,
|
|
164
|
+
}),
|
|
165
|
+
}),
|
|
166
|
+
// A void brings the form back to pending and removes the user's notice.
|
|
167
|
+
voidProvisionalConsent: build.mutation<VoidProvisionalConsentArgs>({
|
|
168
|
+
invalidatesTags: ["ConsentStatus", "PendingConsents"],
|
|
169
|
+
query: ({reason, responseId}) => ({
|
|
170
|
+
body: {reason},
|
|
171
|
+
method: "POST",
|
|
172
|
+
url: `${base}/consent-responses/${encodeURIComponent(responseId)}/void`,
|
|
173
|
+
}),
|
|
174
|
+
}),
|
|
175
|
+
}),
|
|
176
|
+
overrideExisting: false,
|
|
177
|
+
});
|
|
178
|
+
byBase.set(base, enhanced);
|
|
179
|
+
return enhanced;
|
|
180
|
+
};
|
|
181
|
+
|
|
182
|
+
/** Consent status of each form for `userId`, for staff who sign consent on the user's behalf. */
|
|
183
|
+
export const useProvisionalConsent = ({
|
|
184
|
+
api,
|
|
185
|
+
baseUrl,
|
|
186
|
+
userId,
|
|
187
|
+
}: {
|
|
188
|
+
/** The consumer's RTK Query api. Typed loosely, like `ConsentNavigator`, so any app api fits. */
|
|
189
|
+
api: unknown;
|
|
190
|
+
baseUrl?: string;
|
|
191
|
+
userId: string;
|
|
192
|
+
}): UseProvisionalConsentResult => {
|
|
193
|
+
const enhancedApi = getEnhancedApi(api as ProvisionalConsentApi, baseUrl || "");
|
|
194
|
+
const {data, error, isLoading, refetch} = enhancedApi.useGetConsentStatusQuery(userId);
|
|
195
|
+
const [signMutation, {isLoading: isSigning}] = enhancedApi.useSignConsentProvisionallyMutation();
|
|
196
|
+
const statuses = Array.isArray(data) ? data : (data?.data ?? []);
|
|
197
|
+
|
|
198
|
+
const sign = useCallback(
|
|
199
|
+
async (
|
|
200
|
+
body: Omit<SignConsentProvisionallyBody, "userId">
|
|
201
|
+
): Promise<ProvisionalConsentResponse> => {
|
|
202
|
+
const result = await signMutation({...body, userId}).unwrap();
|
|
203
|
+
return unwrapData<ProvisionalConsentResponse>(result);
|
|
204
|
+
},
|
|
205
|
+
[signMutation, userId]
|
|
206
|
+
);
|
|
207
|
+
|
|
208
|
+
const [voidMutation, {isLoading: isVoiding}] = enhancedApi.useVoidProvisionalConsentMutation();
|
|
209
|
+
const voidSignature = useCallback(
|
|
210
|
+
async (args: VoidProvisionalConsentArgs): Promise<ProvisionalConsentResponse> => {
|
|
211
|
+
const result = await voidMutation(args).unwrap();
|
|
212
|
+
return unwrapData<ProvisionalConsentResponse>(result);
|
|
213
|
+
},
|
|
214
|
+
[voidMutation]
|
|
215
|
+
);
|
|
216
|
+
|
|
217
|
+
return {error, isLoading, isSigning, isVoiding, refetch, sign, statuses, voidSignature};
|
|
218
|
+
};
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import {describe, expect, it} from "bun:test";
|
|
2
|
+
import type {FC} from "react";
|
|
3
|
+
|
|
4
|
+
import {SkeletonList} from "./Skeleton";
|
|
5
|
+
import {Text} from "./Text";
|
|
6
|
+
import {renderWithTheme} from "./test-utils";
|
|
7
|
+
import {withLoading} from "./withLoading";
|
|
8
|
+
|
|
9
|
+
// Skeletons are hidden from assistive tech, so queries opt in to hidden elements.
|
|
10
|
+
const HIDDEN = {includeHiddenElements: true};
|
|
11
|
+
|
|
12
|
+
interface UserRowProps {
|
|
13
|
+
name: string;
|
|
14
|
+
testID?: string;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
const UserRow: FC<UserRowProps> = ({name, testID}) => <Text testID={testID}>{name}</Text>;
|
|
18
|
+
|
|
19
|
+
describe("withLoading", () => {
|
|
20
|
+
it("renders the wrapped component when not loading", () => {
|
|
21
|
+
const UserRowWithLoading = withLoading(UserRow);
|
|
22
|
+
const {getByText} = renderWithTheme(<UserRowWithLoading name="Ada" />);
|
|
23
|
+
expect(getByText("Ada")).toBeTruthy();
|
|
24
|
+
});
|
|
25
|
+
|
|
26
|
+
it("renders the default placeholder in a busy box while loading", () => {
|
|
27
|
+
const UserRowWithLoading = withLoading(UserRow, {
|
|
28
|
+
loadingComponent: <SkeletonList rows={1} testID="row-skeleton" />,
|
|
29
|
+
});
|
|
30
|
+
const {getByTestId, queryByText} = renderWithTheme(
|
|
31
|
+
<UserRowWithLoading loading name="Ada" testID="user-row" />
|
|
32
|
+
);
|
|
33
|
+
expect(queryByText("Ada")).toBeNull();
|
|
34
|
+
expect(getByTestId("row-skeleton", HIDDEN)).toBeTruthy();
|
|
35
|
+
const container = getByTestId("user-row-loading", HIDDEN);
|
|
36
|
+
expect(container.props["aria-busy"]).toBe(true);
|
|
37
|
+
expect(container.props.accessibilityLabel).toBe("Loading");
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
it("lets the caller override the placeholder and label", () => {
|
|
41
|
+
const UserRowWithLoading = withLoading(UserRow, {
|
|
42
|
+
loadingComponent: <SkeletonList testID="default-skeleton" />,
|
|
43
|
+
});
|
|
44
|
+
const {getByTestId, queryByTestId} = renderWithTheme(
|
|
45
|
+
<UserRowWithLoading
|
|
46
|
+
loading
|
|
47
|
+
loadingComponent={<SkeletonList rows={1} testID="custom-skeleton" />}
|
|
48
|
+
loadingLabel="Loading user"
|
|
49
|
+
name="Ada"
|
|
50
|
+
testID="user-row"
|
|
51
|
+
/>
|
|
52
|
+
);
|
|
53
|
+
expect(getByTestId("custom-skeleton", HIDDEN)).toBeTruthy();
|
|
54
|
+
expect(queryByTestId("default-skeleton", HIDDEN)).toBeNull();
|
|
55
|
+
expect(getByTestId("user-row-loading", HIDDEN).props.accessibilityLabel).toBe("Loading user");
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
it("names the wrapper after the wrapped component", () => {
|
|
59
|
+
expect(withLoading(UserRow).displayName).toBe("withLoading(UserRow)");
|
|
60
|
+
});
|
|
61
|
+
});
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import type {ComponentType, FC, ReactNode} from "react";
|
|
2
|
+
|
|
3
|
+
import {Box} from "./Box";
|
|
4
|
+
import type {LoadingProps, SkeletonAnimation} from "./Common";
|
|
5
|
+
|
|
6
|
+
export interface WithLoadingOptions {
|
|
7
|
+
/** Animation used when the caller does not pass `loadingAnimation`. */
|
|
8
|
+
loadingAnimation?: SkeletonAnimation;
|
|
9
|
+
/** Placeholder used when the caller does not pass `loadingComponent`. */
|
|
10
|
+
loadingComponent?: ReactNode;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Gives a custom component the shared `LoadingProps` contract. While `loading` is true it renders
|
|
15
|
+
* `loadingComponent` in a busy `Box` instead of the component. Use it for components that do not
|
|
16
|
+
* already take a `loading` prop of their own, since the wrapper consumes it.
|
|
17
|
+
*
|
|
18
|
+
* ```tsx
|
|
19
|
+
* const UserRowWithLoading = withLoading(UserRow, {loadingComponent: <SkeletonList rows={1} />});
|
|
20
|
+
* <UserRowWithLoading loading={isLoading} user={user} />
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
export const withLoading = <P extends object>(
|
|
24
|
+
Component: ComponentType<P>,
|
|
25
|
+
options: WithLoadingOptions = {}
|
|
26
|
+
): FC<P & LoadingProps> => {
|
|
27
|
+
const WithLoading: FC<P & LoadingProps> = ({
|
|
28
|
+
loading,
|
|
29
|
+
loadingAnimation,
|
|
30
|
+
loadingComponent,
|
|
31
|
+
loadingLabel,
|
|
32
|
+
...props
|
|
33
|
+
}) => {
|
|
34
|
+
if (!loading) {
|
|
35
|
+
return <Component {...(props as P)} />;
|
|
36
|
+
}
|
|
37
|
+
const testID = (props as {testID?: string}).testID;
|
|
38
|
+
return (
|
|
39
|
+
<Box
|
|
40
|
+
loading
|
|
41
|
+
loadingAnimation={loadingAnimation ?? options.loadingAnimation}
|
|
42
|
+
loadingComponent={loadingComponent ?? options.loadingComponent}
|
|
43
|
+
loadingLabel={loadingLabel}
|
|
44
|
+
testID={testID ? `${testID}-loading` : undefined}
|
|
45
|
+
/>
|
|
46
|
+
);
|
|
47
|
+
};
|
|
48
|
+
WithLoading.displayName = `withLoading(${Component.displayName ?? Component.name ?? "Component"})`;
|
|
49
|
+
return WithLoading;
|
|
50
|
+
};
|