@terreno/ui 57.19.2 → 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.
Files changed (295) hide show
  1. package/.ai/guidelines/core.md +1 -1
  2. package/CHANGELOG.md +393 -0
  3. package/dist/Accordion.d.ts.map +1 -1
  4. package/dist/Accordion.js +3 -3
  5. package/dist/Accordion.js.map +1 -1
  6. package/dist/Avatar.d.ts.map +1 -1
  7. package/dist/Avatar.js +3 -1
  8. package/dist/Avatar.js.map +1 -1
  9. package/dist/Box.d.ts.map +1 -1
  10. package/dist/Box.js +38 -2
  11. package/dist/Box.js.map +1 -1
  12. package/dist/Card.js +2 -2
  13. package/dist/Card.js.map +1 -1
  14. package/dist/Common.d.ts +120 -7
  15. package/dist/Common.d.ts.map +1 -1
  16. package/dist/Common.js.map +1 -1
  17. package/dist/ConsentFormScreen.d.ts +1 -1
  18. package/dist/ConsentFormScreen.d.ts.map +1 -1
  19. package/dist/ConsentFormScreen.js +13 -4
  20. package/dist/ConsentFormScreen.js.map +1 -1
  21. package/dist/DateTimeField.d.ts.map +1 -1
  22. package/dist/DateTimeField.js +5 -3
  23. package/dist/DateTimeField.js.map +1 -1
  24. package/dist/Field.d.ts.map +1 -1
  25. package/dist/Field.js +2 -0
  26. package/dist/Field.js.map +1 -1
  27. package/dist/FormContainer.d.ts +68 -0
  28. package/dist/FormContainer.d.ts.map +1 -0
  29. package/dist/FormContainer.js +79 -0
  30. package/dist/FormContainer.js.map +1 -0
  31. package/dist/GPTChat.d.ts.map +1 -1
  32. package/dist/GPTChat.js +2 -1
  33. package/dist/GPTChat.js.map +1 -1
  34. package/dist/Heading.d.ts +1 -1
  35. package/dist/Heading.d.ts.map +1 -1
  36. package/dist/Heading.js +5 -2
  37. package/dist/Heading.js.map +1 -1
  38. package/dist/Icon.d.ts +4 -0
  39. package/dist/Icon.d.ts.map +1 -1
  40. package/dist/Icon.js +43 -2
  41. package/dist/Icon.js.map +1 -1
  42. package/dist/LabeledCheckBox.d.ts +22 -0
  43. package/dist/LabeledCheckBox.d.ts.map +1 -0
  44. package/dist/LabeledCheckBox.js +30 -0
  45. package/dist/LabeledCheckBox.js.map +1 -0
  46. package/dist/ListDetailLayout.d.ts +36 -0
  47. package/dist/ListDetailLayout.d.ts.map +1 -0
  48. package/dist/ListDetailLayout.js +153 -0
  49. package/dist/ListDetailLayout.js.map +1 -0
  50. package/dist/MarkdownEditor.d.ts.map +1 -1
  51. package/dist/MarkdownEditor.js +2 -1
  52. package/dist/MarkdownEditor.js.map +1 -1
  53. package/dist/MediaQuery.d.ts +1 -1
  54. package/dist/MediaQuery.d.ts.map +1 -1
  55. package/dist/MediaQuery.js +1 -1
  56. package/dist/MediaQuery.js.map +1 -1
  57. package/dist/OtpField.d.ts +60 -0
  58. package/dist/OtpField.d.ts.map +1 -0
  59. package/dist/OtpField.js +154 -0
  60. package/dist/OtpField.js.map +1 -0
  61. package/dist/ProvisionalConsentSigner.d.ts +21 -0
  62. package/dist/ProvisionalConsentSigner.d.ts.map +1 -0
  63. package/dist/ProvisionalConsentSigner.js +199 -0
  64. package/dist/ProvisionalConsentSigner.js.map +1 -0
  65. package/dist/ResponsiveBreakpoint.d.ts +5 -0
  66. package/dist/ResponsiveBreakpoint.d.ts.map +1 -1
  67. package/dist/ResponsiveBreakpoint.js +7 -0
  68. package/dist/ResponsiveBreakpoint.js.map +1 -1
  69. package/dist/SocialLoginButton.d.ts +10 -0
  70. package/dist/SocialLoginButton.d.ts.map +1 -1
  71. package/dist/SocialLoginButton.js +26 -8
  72. package/dist/SocialLoginButton.js.map +1 -1
  73. package/dist/SplitPage.d.ts +11 -0
  74. package/dist/SplitPage.d.ts.map +1 -1
  75. package/dist/SplitPage.js +11 -5
  76. package/dist/SplitPage.js.map +1 -1
  77. package/dist/SplitPage.native.d.ts.map +1 -1
  78. package/dist/SplitPage.native.js +3 -1
  79. package/dist/SplitPage.native.js.map +1 -1
  80. package/dist/SyncStatusBanner.d.ts +7 -1
  81. package/dist/SyncStatusBanner.d.ts.map +1 -1
  82. package/dist/SyncStatusBanner.js +20 -4
  83. package/dist/SyncStatusBanner.js.map +1 -1
  84. package/dist/TextField.d.ts.map +1 -1
  85. package/dist/TextField.js +44 -10
  86. package/dist/TextField.js.map +1 -1
  87. package/dist/fieldElements/FieldError.d.ts.map +1 -1
  88. package/dist/fieldElements/FieldError.js +1 -1
  89. package/dist/fieldElements/FieldError.js.map +1 -1
  90. package/dist/index.d.ts +19 -3
  91. package/dist/index.d.ts.map +1 -1
  92. package/dist/index.js +14 -1
  93. package/dist/index.js.map +1 -1
  94. package/dist/lazyBoundaries/heavyOptionalExports.d.ts +3 -0
  95. package/dist/lazyBoundaries/heavyOptionalExports.d.ts.map +1 -1
  96. package/dist/lazyBoundaries/heavyOptionalExports.js +2 -0
  97. package/dist/lazyBoundaries/heavyOptionalExports.js.map +1 -1
  98. package/dist/login/LastUsedBadge.d.ts +14 -0
  99. package/dist/login/LastUsedBadge.d.ts.map +1 -0
  100. package/dist/login/LastUsedBadge.js +23 -0
  101. package/dist/login/LastUsedBadge.js.map +1 -0
  102. package/dist/login/LoginAccountCard.d.ts +38 -0
  103. package/dist/login/LoginAccountCard.d.ts.map +1 -0
  104. package/dist/login/LoginAccountCard.js +72 -0
  105. package/dist/login/LoginAccountCard.js.map +1 -0
  106. package/dist/login/LoginAccountList.d.ts +33 -0
  107. package/dist/login/LoginAccountList.d.ts.map +1 -0
  108. package/dist/login/LoginAccountList.js +30 -0
  109. package/dist/login/LoginAccountList.js.map +1 -0
  110. package/dist/login/LoginScreen.d.ts +4 -4
  111. package/dist/login/LoginScreen.d.ts.map +1 -1
  112. package/dist/login/LoginScreen.js +294 -13
  113. package/dist/login/LoginScreen.js.map +1 -1
  114. package/dist/login/OutlinePill.d.ts +28 -0
  115. package/dist/login/OutlinePill.d.ts.map +1 -0
  116. package/dist/login/OutlinePill.js +48 -0
  117. package/dist/login/OutlinePill.js.map +1 -0
  118. package/dist/login/TwoFactorChallengeScreen.d.ts +26 -0
  119. package/dist/login/TwoFactorChallengeScreen.d.ts.map +1 -0
  120. package/dist/login/TwoFactorChallengeScreen.js +139 -0
  121. package/dist/login/TwoFactorChallengeScreen.js.map +1 -0
  122. package/dist/login/loginMethods.d.ts +27 -0
  123. package/dist/login/loginMethods.d.ts.map +1 -0
  124. package/dist/login/loginMethods.js +37 -0
  125. package/dist/login/loginMethods.js.map +1 -0
  126. package/dist/login/loginTypes.d.ts +202 -5
  127. package/dist/login/loginTypes.d.ts.map +1 -1
  128. package/dist/pdfHtmlTemplate.d.ts +17 -0
  129. package/dist/pdfHtmlTemplate.d.ts.map +1 -1
  130. package/dist/pdfHtmlTemplate.js +78 -0
  131. package/dist/pdfHtmlTemplate.js.map +1 -1
  132. package/dist/security/AccountSecurityScreen.d.ts +10 -0
  133. package/dist/security/AccountSecurityScreen.d.ts.map +1 -0
  134. package/dist/security/AccountSecurityScreen.js +50 -0
  135. package/dist/security/AccountSecurityScreen.js.map +1 -0
  136. package/dist/security/LinkedAccountsCard.d.ts +32 -0
  137. package/dist/security/LinkedAccountsCard.d.ts.map +1 -0
  138. package/dist/security/LinkedAccountsCard.js +145 -0
  139. package/dist/security/LinkedAccountsCard.js.map +1 -0
  140. package/dist/security/PasskeysCard.d.ts +39 -0
  141. package/dist/security/PasskeysCard.d.ts.map +1 -0
  142. package/dist/security/PasskeysCard.js +168 -0
  143. package/dist/security/PasskeysCard.js.map +1 -0
  144. package/dist/security/PasswordCard.d.ts +32 -0
  145. package/dist/security/PasswordCard.d.ts.map +1 -0
  146. package/dist/security/PasswordCard.js +198 -0
  147. package/dist/security/PasswordCard.js.map +1 -0
  148. package/dist/security/SessionsCard.d.ts +39 -0
  149. package/dist/security/SessionsCard.d.ts.map +1 -0
  150. package/dist/security/SessionsCard.js +168 -0
  151. package/dist/security/SessionsCard.js.map +1 -0
  152. package/dist/security/TwoFactorSettingsCard.d.ts +55 -0
  153. package/dist/security/TwoFactorSettingsCard.d.ts.map +1 -0
  154. package/dist/security/TwoFactorSettingsCard.js +458 -0
  155. package/dist/security/TwoFactorSettingsCard.js.map +1 -0
  156. package/dist/security/securityMethods.d.ts +40 -0
  157. package/dist/security/securityMethods.d.ts.map +1 -0
  158. package/dist/security/securityMethods.js +66 -0
  159. package/dist/security/securityMethods.js.map +1 -0
  160. package/dist/security/securityTypes.d.ts +467 -0
  161. package/dist/security/securityTypes.d.ts.map +1 -0
  162. package/dist/security/securityTypes.js +2 -0
  163. package/dist/security/securityTypes.js.map +1 -0
  164. package/dist/security/userAgent.d.ts +26 -0
  165. package/dist/security/userAgent.d.ts.map +1 -0
  166. package/dist/security/userAgent.js +80 -0
  167. package/dist/security/userAgent.js.map +1 -0
  168. package/dist/signUp/OAuthButtons.d.ts +28 -5
  169. package/dist/signUp/OAuthButtons.d.ts.map +1 -1
  170. package/dist/signUp/OAuthButtons.js +44 -5
  171. package/dist/signUp/OAuthButtons.js.map +1 -1
  172. package/dist/signUp/SignUpScreen.d.ts.map +1 -1
  173. package/dist/signUp/SignUpScreen.js +50 -5
  174. package/dist/signUp/SignUpScreen.js.map +1 -1
  175. package/dist/signUp/signUpTypes.d.ts +21 -1
  176. package/dist/signUp/signUpTypes.d.ts.map +1 -1
  177. package/dist/useConsentForms.d.ts +9 -0
  178. package/dist/useConsentForms.d.ts.map +1 -1
  179. package/dist/useConsentForms.js +18 -0
  180. package/dist/useConsentForms.js.map +1 -1
  181. package/dist/useProvisionalConsent.d.ts +124 -0
  182. package/dist/useProvisionalConsent.d.ts.map +1 -0
  183. package/dist/useProvisionalConsent.js +79 -0
  184. package/dist/useProvisionalConsent.js.map +1 -0
  185. package/package.json +3 -2
  186. package/src/Accordion.test.tsx +5 -0
  187. package/src/Accordion.tsx +3 -8
  188. package/src/AreaChart.test.tsx +15 -0
  189. package/src/Avatar.test.tsx +8 -0
  190. package/src/Avatar.tsx +2 -0
  191. package/src/BarChart.test.tsx +15 -0
  192. package/src/Box.test.tsx +61 -1
  193. package/src/Box.tsx +44 -2
  194. package/src/Card.tsx +2 -2
  195. package/src/Common.ts +134 -7
  196. package/src/ConsentFormScreen.test.tsx +84 -0
  197. package/src/ConsentFormScreen.tsx +28 -4
  198. package/src/DateTimeField.tsx +5 -3
  199. package/src/DonutChart.test.tsx +15 -0
  200. package/src/Field.tsx +2 -0
  201. package/src/FilePickerButton.test.tsx +35 -0
  202. package/src/FormContainer.test.tsx +242 -0
  203. package/src/FormContainer.tsx +177 -0
  204. package/src/GPTChat.test.tsx +16 -0
  205. package/src/GPTChat.tsx +8 -2
  206. package/src/Heading.test.tsx +14 -0
  207. package/src/Heading.tsx +6 -1
  208. package/src/Icon.test.tsx +52 -1
  209. package/src/Icon.tsx +92 -3
  210. package/src/IconButton.test.tsx +85 -0
  211. package/src/LabeledCheckBox.test.tsx +45 -0
  212. package/src/LabeledCheckBox.tsx +89 -0
  213. package/src/ListDetailLayout.tsx +247 -0
  214. package/src/MarkdownEditor.tsx +2 -1
  215. package/src/MediaQuery.ts +1 -0
  216. package/src/OtpField.test.tsx +280 -0
  217. package/src/OtpField.tsx +307 -0
  218. package/src/ProvisionalConsentSigner.test.tsx +625 -0
  219. package/src/ProvisionalConsentSigner.tsx +423 -0
  220. package/src/ResponsiveBreakpoint.test.tsx +7 -0
  221. package/src/ResponsiveBreakpoint.tsx +14 -0
  222. package/src/RootImportRegression.test.tsx +3 -0
  223. package/src/SocialLoginButton.test.tsx +14 -0
  224. package/src/SocialLoginButton.tsx +51 -7
  225. package/src/SplitPage.native.tsx +3 -1
  226. package/src/SplitPage.tsx +11 -5
  227. package/src/SyncStatusBanner.test.tsx +61 -4
  228. package/src/SyncStatusBanner.tsx +29 -3
  229. package/src/TextField.test.tsx +150 -0
  230. package/src/TextField.tsx +66 -8
  231. package/src/__snapshots__/AddressField.test.tsx.snap +12 -0
  232. package/src/__snapshots__/AiSuggestionBox.test.tsx.snap +15 -0
  233. package/src/__snapshots__/Avatar.test.tsx.snap +1 -0
  234. package/src/__snapshots__/CustomSelectField.test.tsx.snap +3 -0
  235. package/src/__snapshots__/EmailField.test.tsx.snap +6 -0
  236. package/src/__snapshots__/Field.test.tsx.snap +37 -0
  237. package/src/__snapshots__/HeightField.test.tsx.snap +2 -0
  238. package/src/__snapshots__/MobileAddressAutoComplete.test.tsx.snap +3 -0
  239. package/src/__snapshots__/NumberField.test.tsx.snap +3 -0
  240. package/src/__snapshots__/PhoneNumberField.test.tsx.snap +12 -0
  241. package/src/__snapshots__/Slider.test.tsx.snap +1 -0
  242. package/src/__snapshots__/SocialLoginButton.test.tsx.snap +43 -22
  243. package/src/__snapshots__/TapToEdit.test.tsx.snap +3 -0
  244. package/src/__snapshots__/TextArea.test.tsx.snap +17 -1
  245. package/src/__snapshots__/TextField.test.tsx.snap +19 -2
  246. package/src/__snapshots__/TypedSignatureField.test.tsx.snap +3 -0
  247. package/src/__snapshots__/UnifiedAddressAutoComplete.test.tsx.snap +18 -0
  248. package/src/__snapshots__/WebAddressAutocomplete.test.tsx.snap +12 -0
  249. package/src/bunSetup.ts +13 -1
  250. package/src/fieldElements/FieldError.tsx +1 -0
  251. package/src/fieldElements/__snapshots__/FieldError.test.tsx.snap +2 -0
  252. package/src/index.tsx +42 -1
  253. package/src/isolated/ListDetailLayout.isolated.tsx +634 -0
  254. package/src/lazyBoundaries/heavyOptionalExports.tsx +7 -0
  255. package/src/login/LastUsedBadge.tsx +40 -0
  256. package/src/login/LoginAccountCard.tsx +205 -0
  257. package/src/login/LoginAccountList.tsx +115 -0
  258. package/src/login/LoginScreen.test.tsx +837 -1
  259. package/src/login/LoginScreen.tsx +674 -91
  260. package/src/login/OutlinePill.tsx +110 -0
  261. package/src/login/TwoFactorChallengeScreen.test.tsx +376 -0
  262. package/src/login/TwoFactorChallengeScreen.tsx +307 -0
  263. package/src/login/__snapshots__/LoginScreen.test.tsx.snap +1454 -334
  264. package/src/login/loginMethods.test.ts +53 -0
  265. package/src/login/loginMethods.ts +60 -0
  266. package/src/login/loginTypes.ts +208 -5
  267. package/src/pdfHtmlTemplate.test.ts +243 -4
  268. package/src/pdfHtmlTemplate.ts +93 -0
  269. package/src/security/AccountSecurityScreen.test.tsx +262 -0
  270. package/src/security/AccountSecurityScreen.tsx +156 -0
  271. package/src/security/LinkedAccountsCard.test.tsx +371 -0
  272. package/src/security/LinkedAccountsCard.tsx +297 -0
  273. package/src/security/PasskeysCard.test.tsx +378 -0
  274. package/src/security/PasskeysCard.tsx +371 -0
  275. package/src/security/PasswordCard.test.tsx +445 -0
  276. package/src/security/PasswordCard.tsx +342 -0
  277. package/src/security/SessionsCard.test.tsx +349 -0
  278. package/src/security/SessionsCard.tsx +362 -0
  279. package/src/security/TwoFactorSettingsCard.test.tsx +700 -0
  280. package/src/security/TwoFactorSettingsCard.tsx +872 -0
  281. package/src/security/securityMethods.test.ts +101 -0
  282. package/src/security/securityMethods.ts +104 -0
  283. package/src/security/securityTypes.ts +480 -0
  284. package/src/security/userAgent.test.ts +119 -0
  285. package/src/security/userAgent.ts +102 -0
  286. package/src/signUp/OAuthButtons.test.tsx +27 -0
  287. package/src/signUp/OAuthButtons.tsx +153 -19
  288. package/src/signUp/SignUpScreen.test.tsx +170 -1
  289. package/src/signUp/SignUpScreen.tsx +87 -25
  290. package/src/signUp/__snapshots__/SignUpScreen.test.tsx.snap +22 -11
  291. package/src/signUp/signUpTypes.ts +23 -1
  292. package/src/useConsentForms.test.ts +37 -1
  293. package/src/useConsentForms.ts +25 -0
  294. package/src/useProvisionalConsent.test.ts +256 -0
  295. package/src/useProvisionalConsent.ts +218 -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
+ };