@terreno/admin-frontend 0.20.2 → 0.22.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 (117) hide show
  1. package/.ai/guidelines/core.md +10 -0
  2. package/dist/AdminBreadcrumbs.d.ts +13 -0
  3. package/dist/AdminBreadcrumbs.js +22 -0
  4. package/dist/AdminBreadcrumbs.js.map +1 -0
  5. package/dist/AdminFieldRenderer.js +3 -3
  6. package/dist/AdminFieldRenderer.js.map +1 -1
  7. package/dist/AdminFieldRendererCore.d.ts +2 -0
  8. package/dist/AdminFieldRendererCore.js +28 -18
  9. package/dist/AdminFieldRendererCore.js.map +1 -1
  10. package/dist/AdminHome.d.ts +22 -0
  11. package/dist/AdminHome.js +189 -0
  12. package/dist/AdminHome.js.map +1 -0
  13. package/dist/AdminModelForm.d.ts +24 -1
  14. package/dist/AdminModelForm.js +185 -14
  15. package/dist/AdminModelForm.js.map +1 -1
  16. package/dist/AdminModelList.d.ts +4 -0
  17. package/dist/AdminModelList.js +19 -4
  18. package/dist/AdminModelList.js.map +1 -1
  19. package/dist/AdminModelTable.d.ts +2 -27
  20. package/dist/AdminModelTable.js +316 -60
  21. package/dist/AdminModelTable.js.map +1 -1
  22. package/dist/AdminNestedArrayField.d.ts +1 -0
  23. package/dist/AdminNestedArrayField.js +26 -6
  24. package/dist/AdminNestedArrayField.js.map +1 -1
  25. package/dist/AdminObjectPicker.d.ts +1 -0
  26. package/dist/AdminObjectPicker.js +6 -2
  27. package/dist/AdminObjectPicker.js.map +1 -1
  28. package/dist/AdminPrimitiveArrayField.d.ts +1 -0
  29. package/dist/AdminPrimitiveArrayField.js +9 -8
  30. package/dist/AdminPrimitiveArrayField.js.map +1 -1
  31. package/dist/AdminRefField.js +2 -2
  32. package/dist/AdminRefField.js.map +1 -1
  33. package/dist/AdminScriptList.js +114 -7
  34. package/dist/AdminScriptList.js.map +1 -1
  35. package/dist/AdminScriptRunModal.d.ts +5 -0
  36. package/dist/AdminScriptRunModal.js +136 -30
  37. package/dist/AdminScriptRunModal.js.map +1 -1
  38. package/dist/AdminShell.d.ts +39 -0
  39. package/dist/AdminShell.js +80 -0
  40. package/dist/AdminShell.js.map +1 -0
  41. package/dist/AdminShellLayout.d.ts +23 -0
  42. package/dist/AdminShellLayout.js +32 -0
  43. package/dist/AdminShellLayout.js.map +1 -0
  44. package/dist/AdminVersionConfig.d.ts +5 -0
  45. package/dist/AdminVersionConfig.js +15 -5
  46. package/dist/AdminVersionConfig.js.map +1 -1
  47. package/dist/ConfigurationScreen.js +3 -3
  48. package/dist/ConfigurationScreen.js.map +1 -1
  49. package/dist/ConsentFormEditor.js +2 -2
  50. package/dist/ConsentFormEditor.js.map +1 -1
  51. package/dist/ConsentFormList.js +1 -1
  52. package/dist/ConsentFormList.js.map +1 -1
  53. package/dist/ConsentResponseViewer.js +3 -3
  54. package/dist/ConsentResponseViewer.js.map +1 -1
  55. package/dist/DocumentStorageBrowser.js +1 -1
  56. package/dist/DocumentStorageBrowser.js.map +1 -1
  57. package/dist/adminModelListQueryParams.d.ts +14 -0
  58. package/dist/adminModelListQueryParams.js +51 -0
  59. package/dist/adminModelListQueryParams.js.map +1 -0
  60. package/dist/adminShellNav.d.ts +10 -0
  61. package/dist/adminShellNav.js +29 -0
  62. package/dist/adminShellNav.js.map +1 -0
  63. package/dist/index.d.ts +6 -1
  64. package/dist/index.js +5 -0
  65. package/dist/index.js.map +1 -1
  66. package/dist/scriptRunUtils.d.ts +36 -0
  67. package/dist/scriptRunUtils.js +121 -0
  68. package/dist/scriptRunUtils.js.map +1 -0
  69. package/dist/types.d.ts +70 -0
  70. package/dist/types.js.map +1 -1
  71. package/dist/useAdminApi.d.ts +1 -0
  72. package/dist/useAdminApi.js +11 -0
  73. package/dist/useAdminApi.js.map +1 -1
  74. package/dist/useAdminBackgroundTask.d.ts +12 -0
  75. package/dist/useAdminBackgroundTask.js +26 -0
  76. package/dist/useAdminBackgroundTask.js.map +1 -0
  77. package/dist/useAdminScripts.d.ts +19 -1
  78. package/dist/useAdminScripts.js +33 -4
  79. package/dist/useAdminScripts.js.map +1 -1
  80. package/package.json +4 -3
  81. package/src/AdminBreadcrumbs.test.tsx +27 -0
  82. package/src/AdminBreadcrumbs.tsx +63 -0
  83. package/src/AdminFieldRenderer.tsx +3 -0
  84. package/src/AdminFieldRendererCore.tsx +59 -1
  85. package/src/AdminHome.test.tsx +208 -0
  86. package/src/AdminHome.tsx +474 -0
  87. package/src/AdminModelForm.test.tsx +81 -1
  88. package/src/AdminModelForm.tsx +282 -34
  89. package/src/AdminModelList.test.tsx +1 -1
  90. package/src/AdminModelList.tsx +72 -39
  91. package/src/AdminModelTable.test.tsx +11 -0
  92. package/src/AdminModelTable.tsx +530 -92
  93. package/src/AdminNestedArrayField.tsx +59 -9
  94. package/src/AdminObjectPicker.tsx +19 -1
  95. package/src/AdminPrimitiveArrayField.tsx +30 -15
  96. package/src/AdminRefField.tsx +2 -0
  97. package/src/AdminScriptList.tsx +307 -30
  98. package/src/AdminScriptRunModal.tsx +410 -95
  99. package/src/AdminShell.tsx +296 -0
  100. package/src/AdminShellLayout.tsx +34 -0
  101. package/src/AdminVersionConfig.tsx +120 -76
  102. package/src/ConfigurationScreen.tsx +4 -2
  103. package/src/ConsentFormEditor.tsx +3 -1
  104. package/src/ConsentFormList.tsx +1 -1
  105. package/src/ConsentResponseViewer.tsx +3 -3
  106. package/src/DocumentStorageBrowser.tsx +1 -1
  107. package/src/adminModelListQueryParams.ts +61 -0
  108. package/src/adminShellNav.test.ts +29 -0
  109. package/src/adminShellNav.ts +33 -0
  110. package/src/index.tsx +6 -1
  111. package/src/isolated/AdminScriptRunModal.isolated.tsx +152 -1
  112. package/src/scriptRunUtils.test.ts +146 -0
  113. package/src/scriptRunUtils.ts +149 -0
  114. package/src/types.ts +69 -0
  115. package/src/useAdminApi.ts +11 -0
  116. package/src/useAdminBackgroundTask.ts +40 -0
  117. package/src/useAdminScripts.ts +56 -5
@@ -28,6 +28,7 @@ interface AdminNestedArrayFieldProps {
28
28
  parentFormState?: Record<string, AdminFieldValue>;
29
29
  /** Forwarded to nested field renderers so refs in sub-documents can use custom renderers. */
30
30
  refRenderers?: RefRendererMap;
31
+ readOnly?: boolean;
31
32
  }
32
33
 
33
34
  /**
@@ -49,6 +50,7 @@ const renderNestedSubField = ({
49
50
  onSubFieldChange,
50
51
  parentFormState,
51
52
  refRenderers,
53
+ readOnly,
52
54
  }: {
53
55
  api: AdminApi;
54
56
  baseUrl?: string;
@@ -62,6 +64,7 @@ const renderNestedSubField = ({
62
64
  onSubFieldChange: (index: number, fieldKey: string, fieldValue: AdminFieldValue) => void;
63
65
  parentFormState?: Record<string, AdminFieldValue>;
64
66
  refRenderers?: RefRendererMap;
67
+ readOnly?: boolean;
65
68
  }): React.ReactElement => {
66
69
  if (fieldConfig.type === "array" && fieldConfig.items) {
67
70
  return (
@@ -75,6 +78,7 @@ const renderNestedSubField = ({
75
78
  modelConfigs={modelConfigs}
76
79
  onChange={(val) => onSubFieldChange(index, fieldKey, val)}
77
80
  parentFormState={parentFormState}
81
+ readOnly={readOnly}
78
82
  refRenderers={refRenderers}
79
83
  routeBase={routeBase}
80
84
  title={startCase(fieldKey)}
@@ -94,6 +98,7 @@ const renderNestedSubField = ({
94
98
  modelConfigs={modelConfigs}
95
99
  onChange={(val) => onSubFieldChange(index, fieldKey, val)}
96
100
  parentFormState={parentFormState}
101
+ readOnly={readOnly}
97
102
  refRenderers={refRenderers}
98
103
  routeBase={routeBase}
99
104
  value={fieldValue}
@@ -140,7 +145,9 @@ export const AdminNestedArrayField: React.FC<AdminNestedArrayFieldProps> = ({
140
145
  modelConfigs,
141
146
  parentFormState,
142
147
  refRenderers,
148
+ readOnly,
143
149
  }) => {
150
+ const isReadOnly = Boolean(readOnly);
144
151
  const arrayValue = useMemo((): Record<string, AdminFieldValue>[] => {
145
152
  return Array.isArray(value) ? value : [];
146
153
  }, [value]);
@@ -239,13 +246,15 @@ export const AdminNestedArrayField: React.FC<AdminNestedArrayFieldProps> = ({
239
246
  <Text bold size="sm">
240
247
  Item {index + 1}
241
248
  </Text>
242
- <IconButton
243
- accessibilityLabel="Remove item"
244
- iconName="trash"
245
- onClick={() => handleRemoveItem(index)}
246
- tooltipText="Remove"
247
- variant="destructive"
248
- />
249
+ {!isReadOnly ? (
250
+ <IconButton
251
+ accessibilityLabel="Remove item"
252
+ iconName="trash"
253
+ onClick={() => handleRemoveItem(index)}
254
+ tooltipText="Remove"
255
+ variant="destructive"
256
+ />
257
+ ) : null}
249
258
  </Box>
250
259
  {subFieldEntries.map(([fieldKey, fieldConfig]) =>
251
260
  renderNestedSubField({
@@ -259,6 +268,7 @@ export const AdminNestedArrayField: React.FC<AdminNestedArrayFieldProps> = ({
259
268
  modelConfigs,
260
269
  onSubFieldChange: handleSubFieldChange,
261
270
  parentFormState: subFieldParentFormState,
271
+ readOnly: isReadOnly,
262
272
  refRenderers,
263
273
  routeBase,
264
274
  })
@@ -280,6 +290,7 @@ export const AdminNestedArrayField: React.FC<AdminNestedArrayFieldProps> = ({
280
290
  refRenderers,
281
291
  handleRemoveItem,
282
292
  handleSubFieldChange,
293
+ isReadOnly,
283
294
  ]
284
295
  );
285
296
 
@@ -289,7 +300,9 @@ export const AdminNestedArrayField: React.FC<AdminNestedArrayFieldProps> = ({
289
300
  <Box gap={2}>
290
301
  <Box alignItems="center" direction="row" justifyContent="between">
291
302
  <Heading size="sm">{title}</Heading>
292
- <Button iconName="plus" onClick={handleAddItem} text="Add" variant="outline" />
303
+ {!isReadOnly ? (
304
+ <Button iconName="plus" onClick={handleAddItem} text="Add" variant="outline" />
305
+ ) : null}
293
306
  </Box>
294
307
  {helperText ? (
295
308
  <Text color="secondaryDark" size="sm">
@@ -304,7 +317,44 @@ export const AdminNestedArrayField: React.FC<AdminNestedArrayFieldProps> = ({
304
317
 
305
318
  {arrayValue.length === 0 ? (
306
319
  <Box alignItems="center" padding={3}>
307
- <Text color="secondaryDark">No items. Click &quot;Add&quot; to create one.</Text>
320
+ <Text color="secondaryDark">
321
+ {isReadOnly ? "No items." : 'No items. Click "Add" to create one.'}
322
+ </Text>
323
+ </Box>
324
+ ) : isReadOnly ? (
325
+ <Box gap={2}>
326
+ {arrayValue.map((itemData, index) => {
327
+ const subFieldParentFormState = {
328
+ ...(parentFormState ?? {}),
329
+ ...itemData,
330
+ };
331
+ return (
332
+ <Card key={`ro-${index}`} padding={3}>
333
+ <Box gap={2}>
334
+ <Text bold size="sm">
335
+ Item {index + 1}
336
+ </Text>
337
+ {subFieldEntries.map(([fieldKey, fieldConfig]) =>
338
+ renderNestedSubField({
339
+ api,
340
+ apiBase,
341
+ baseUrl,
342
+ fieldConfig,
343
+ fieldKey,
344
+ fieldValue: itemData[fieldKey],
345
+ index,
346
+ modelConfigs,
347
+ onSubFieldChange: handleSubFieldChange,
348
+ parentFormState: subFieldParentFormState,
349
+ readOnly: true,
350
+ refRenderers,
351
+ routeBase,
352
+ })
353
+ )}
354
+ </Box>
355
+ </Card>
356
+ );
357
+ })}
308
358
  </Box>
309
359
  ) : (
310
360
  <DraggableList
@@ -22,6 +22,7 @@ interface AdminObjectPickerProps {
22
22
  onChange: (value: string) => void;
23
23
  errorText?: string;
24
24
  helperText?: string;
25
+ readOnly?: boolean;
25
26
  }
26
27
 
27
28
  const DISPLAY_FIELDS = ["name", "title", "email", "label", "displayName"] as const;
@@ -65,6 +66,7 @@ export const AdminObjectPicker: React.FC<AdminObjectPickerProps> = ({
65
66
  onChange,
66
67
  errorText,
67
68
  helperText,
69
+ readOnly,
68
70
  }) => {
69
71
  const [searchText, setSearchText] = useState("");
70
72
  const [isOpen, setIsOpen] = useState(false);
@@ -118,7 +120,7 @@ export const AdminObjectPicker: React.FC<AdminObjectPickerProps> = ({
118
120
  });
119
121
 
120
122
  // Fetch the currently selected item to display its name
121
- const {data: selectedItem} = useReadQuery(value, {
123
+ const {data: selectedItem, isLoading: isSelectedLoading} = useReadQuery(value, {
122
124
  skip: !value,
123
125
  });
124
126
 
@@ -175,6 +177,22 @@ export const AdminObjectPicker: React.FC<AdminObjectPickerProps> = ({
175
177
  ? searchData
176
178
  : ((searchData as {data?: unknown[]} | undefined)?.data ?? []);
177
179
 
180
+ if (readOnly) {
181
+ const roValue =
182
+ selectedDisplay || (value && isSelectedLoading ? "Loading…" : value ? String(value) : "");
183
+ return (
184
+ <TextField
185
+ disabled
186
+ errorText={errorText}
187
+ helperText={helperText}
188
+ onChange={() => {}}
189
+ testID={`admin-picker-${refModelName}-readonly`}
190
+ title={title}
191
+ value={roValue}
192
+ />
193
+ );
194
+ }
195
+
178
196
  return (
179
197
  <Box gap={1}>
180
198
  {value && selectedDisplay && !isChanging ? (
@@ -36,6 +36,7 @@ interface AdminPrimitiveArrayFieldProps {
36
36
  * {@link AdminRefField} for each ref item.
37
37
  */
38
38
  refRenderers?: RefRendererMap;
39
+ readOnly?: boolean;
39
40
  }
40
41
 
41
42
  type PrimitiveItem = string | number | boolean;
@@ -70,7 +71,9 @@ export const AdminPrimitiveArrayField: React.FC<AdminPrimitiveArrayFieldProps> =
70
71
  routeBase,
71
72
  modelConfigs,
72
73
  refRenderers,
74
+ readOnly,
73
75
  }) => {
76
+ const isReadOnly = Boolean(readOnly);
74
77
  const arrayValue = Array.isArray(value) ? value : [];
75
78
 
76
79
  const handleAdd = useCallback(() => {
@@ -100,6 +103,7 @@ export const AdminPrimitiveArrayField: React.FC<AdminPrimitiveArrayFieldProps> =
100
103
  if (itemType === "boolean") {
101
104
  return (
102
105
  <BooleanField
106
+ disabled={isReadOnly}
103
107
  onChange={(val: boolean) => handleUpdate(index, val)}
104
108
  title=""
105
109
  value={Boolean(item)}
@@ -109,6 +113,7 @@ export const AdminPrimitiveArrayField: React.FC<AdminPrimitiveArrayFieldProps> =
109
113
  if (itemEnum && itemEnum.length > 0) {
110
114
  return (
111
115
  <SelectField
116
+ disabled={isReadOnly}
112
117
  onChange={(val: string) => handleUpdate(index, val)}
113
118
  options={itemEnum.map((v) => ({label: startCase(v), value: v}))}
114
119
  title=""
@@ -125,6 +130,7 @@ export const AdminPrimitiveArrayField: React.FC<AdminPrimitiveArrayFieldProps> =
125
130
  apiBase={apiBase}
126
131
  baseUrl={baseUrl}
127
132
  onChange={(val: string) => handleUpdate(index, val)}
133
+ readOnly={isReadOnly}
128
134
  refModelName={itemRef}
129
135
  routeBase={routeBase}
130
136
  routePath={refModel?.routePath ?? ""}
@@ -140,6 +146,7 @@ export const AdminPrimitiveArrayField: React.FC<AdminPrimitiveArrayFieldProps> =
140
146
  apiBase={apiBase}
141
147
  baseUrl={baseUrl}
142
148
  onChange={(val: string) => handleUpdate(index, val)}
149
+ readOnly={isReadOnly}
143
150
  refModelName={refModel.name}
144
151
  routeBase={routeBase}
145
152
  routePath={refModel.routePath}
@@ -152,6 +159,7 @@ export const AdminPrimitiveArrayField: React.FC<AdminPrimitiveArrayFieldProps> =
152
159
  if (itemType === "number") {
153
160
  return (
154
161
  <TextField
162
+ disabled={isReadOnly}
155
163
  onChange={(text: string) => {
156
164
  const num = Number(text);
157
165
  handleUpdate(index, Number.isNaN(num) ? text : num);
@@ -165,6 +173,7 @@ export const AdminPrimitiveArrayField: React.FC<AdminPrimitiveArrayFieldProps> =
165
173
  // Default: string
166
174
  return (
167
175
  <TextField
176
+ disabled={isReadOnly}
168
177
  onChange={(val: string) => handleUpdate(index, val)}
169
178
  testID={`admin-array-item-${index}`}
170
179
  title=""
@@ -177,13 +186,15 @@ export const AdminPrimitiveArrayField: React.FC<AdminPrimitiveArrayFieldProps> =
177
186
  <Box gap={2}>
178
187
  <Box alignItems="center" direction="row" justifyContent="between">
179
188
  <Heading size="sm">{title}</Heading>
180
- <Button
181
- iconName="plus"
182
- onClick={handleAdd}
183
- testID={`admin-array-add-${title}`}
184
- text="Add"
185
- variant="outline"
186
- />
189
+ {!isReadOnly ? (
190
+ <Button
191
+ iconName="plus"
192
+ onClick={handleAdd}
193
+ testID={`admin-array-add-${title}`}
194
+ text="Add"
195
+ variant="outline"
196
+ />
197
+ ) : null}
187
198
  </Box>
188
199
  {helperText ? (
189
200
  <Text color="secondaryDark" size="sm">
@@ -198,19 +209,23 @@ export const AdminPrimitiveArrayField: React.FC<AdminPrimitiveArrayFieldProps> =
198
209
 
199
210
  {arrayValue.length === 0 ? (
200
211
  <Box alignItems="center" padding={3}>
201
- <Text color="secondaryDark">No items. Click &quot;Add&quot; to create one.</Text>
212
+ <Text color="secondaryDark">
213
+ {isReadOnly ? "No items." : 'No items. Click "Add" to create one.'}
214
+ </Text>
202
215
  </Box>
203
216
  ) : (
204
217
  arrayValue.map((item, index) => (
205
218
  <Box alignItems="center" direction="row" gap={2} key={`item-${index}`}>
206
219
  <Box flex="grow">{renderItemInput(item, index)}</Box>
207
- <IconButton
208
- accessibilityLabel="Remove item"
209
- iconName="trash"
210
- onClick={() => handleRemove(index)}
211
- testID={`admin-array-remove-${index}`}
212
- variant="destructive"
213
- />
220
+ {!isReadOnly ? (
221
+ <IconButton
222
+ accessibilityLabel="Remove item"
223
+ iconName="trash"
224
+ onClick={() => handleRemove(index)}
225
+ testID={`admin-array-remove-${index}`}
226
+ variant="destructive"
227
+ />
228
+ ) : null}
214
229
  </Box>
215
230
  ))
216
231
  )}
@@ -17,6 +17,7 @@ export const AdminRefField: React.FC<RefFieldRendererProps> = ({
17
17
  onChange,
18
18
  errorText,
19
19
  helperText,
20
+ readOnly,
20
21
  }) => {
21
22
  return (
22
23
  <AdminObjectPicker
@@ -24,6 +25,7 @@ export const AdminRefField: React.FC<RefFieldRendererProps> = ({
24
25
  errorText={errorText}
25
26
  helperText={helperText}
26
27
  onChange={onChange}
28
+ readOnly={readOnly}
27
29
  refModelName={refModelName}
28
30
  routePath={routePath}
29
31
  title={title}