@olenbetong/appframe-ds 1.5.0 → 1.6.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.
Files changed (159) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/package.json +17 -16
  3. package/scripts/copyAssets.mjs +27 -27
  4. package/src/AfLookup/Lookup.css +147 -130
  5. package/src/AfLookup/Lookup.tsx +186 -186
  6. package/src/AfLookup/LookupCombobox.css +69 -72
  7. package/src/AfLookup/LookupCombobox.tsx +273 -237
  8. package/src/AfLookup/LookupEdit.tsx +130 -130
  9. package/src/AfLookup/LookupGrid.css +145 -52
  10. package/src/AfLookup/LookupGrid.test.tsx +142 -0
  11. package/src/AfLookup/LookupGrid.tsx +324 -124
  12. package/src/AfLookup/index.ts +5 -5
  13. package/src/autocomplete/Autocomplete.css +253 -256
  14. package/src/autocomplete/Autocomplete.tsx +320 -320
  15. package/src/autocomplete/AutocompleteFrame.tsx +168 -168
  16. package/src/autocomplete/Combobox.tsx +286 -286
  17. package/src/autocomplete/index.ts +4 -4
  18. package/src/autocomplete/types.ts +204 -204
  19. package/src/autocomplete/utils.ts +183 -183
  20. package/src/binding/BoundNumberInput.tsx +42 -0
  21. package/src/binding/BoundNumericTextField.tsx +102 -102
  22. package/src/binding/BoundTextField.tsx +49 -49
  23. package/src/binding/CancelButton.tsx +30 -30
  24. package/src/binding/CancelIconButton.tsx +30 -30
  25. package/src/binding/DataEditToolbar.css +23 -23
  26. package/src/binding/DataEditToolbar.tsx +84 -84
  27. package/src/binding/DeleteButton.tsx +35 -35
  28. package/src/binding/DeleteIconButton.tsx +35 -35
  29. package/src/binding/RefreshButton.tsx +31 -31
  30. package/src/binding/RefreshIconButton.tsx +33 -33
  31. package/src/binding/RefreshRowIconButton.tsx +33 -33
  32. package/src/binding/SaveButton.tsx +37 -37
  33. package/src/binding/SaveIconButton.tsx +38 -38
  34. package/src/binding/index.ts +20 -19
  35. package/src/container/Container.tsx +50 -50
  36. package/src/container/index.ts +1 -1
  37. package/src/cutoff/CutOffPicker.css +12 -12
  38. package/src/cutoff/CutOffPicker.tsx +165 -165
  39. package/src/cutoff/context.tsx +194 -194
  40. package/src/cutoff/dsCutOffDates.ts +21 -21
  41. package/src/cutoff/index.ts +4 -4
  42. package/src/cutoff/utils.test.ts +59 -59
  43. package/src/cutoff/utils.ts +276 -276
  44. package/src/filter/ChipListInput.tsx +79 -79
  45. package/src/filter/FieldFilterPanel.css +150 -150
  46. package/src/filter/FieldFilterPanel.tsx +309 -309
  47. package/src/filter/FilterBuilder.css +152 -152
  48. package/src/filter/FilterBuilder.test.tsx +153 -153
  49. package/src/filter/FilterBuilder.tsx +435 -435
  50. package/src/filter/FilterEditor.css +231 -231
  51. package/src/filter/FilterEditor.test.tsx +285 -285
  52. package/src/filter/FilterEditor.tsx +75 -75
  53. package/src/filter/FilterGroupEditor.tsx +160 -160
  54. package/src/filter/FilterNameDialog.css +22 -22
  55. package/src/filter/FilterNameDialog.tsx +81 -81
  56. package/src/filter/FilterRow.tsx +117 -117
  57. package/src/filter/FilterShareDialog.css +28 -28
  58. package/src/filter/FilterShareDialog.tsx +201 -201
  59. package/src/filter/FilterStringField.tsx +78 -78
  60. package/src/filter/FilterValueEditor.tsx +239 -239
  61. package/src/filter/SavedFilterTree.css +107 -107
  62. package/src/filter/SavedFilterTree.test.tsx +94 -94
  63. package/src/filter/SavedFilterTree.tsx +218 -218
  64. package/src/filter/fieldFilter.test.ts +158 -158
  65. package/src/filter/fieldFilter.ts +139 -139
  66. package/src/filter/index.ts +27 -27
  67. package/src/filter/types.ts +38 -38
  68. package/src/filter/useDistinctValues.test.ts +102 -102
  69. package/src/filter/useDistinctValues.ts +230 -230
  70. package/src/global.d.ts +11 -11
  71. package/src/grid/formatters.ts +23 -0
  72. package/src/grid/useAfColumns.tsx +28 -4
  73. package/src/grid/utcDate.test.ts +25 -0
  74. package/src/grid/utcDate.ts +28 -0
  75. package/src/grid/utcDateEditing.tsx +11 -0
  76. package/src/i18n.ts +13 -13
  77. package/src/index.ts +14 -14
  78. package/src/input/InputAdornments.css +80 -84
  79. package/src/input/InputAdornments.tsx +102 -102
  80. package/src/input/NumberInput.css +9 -0
  81. package/src/input/NumberInput.test.tsx +212 -0
  82. package/src/input/NumberInput.tsx +268 -0
  83. package/src/input/index.ts +3 -1
  84. package/src/input/numberFormat.test.ts +79 -0
  85. package/src/input/numberFormat.ts +94 -0
  86. package/src/layout/AppMenu.tsx +74 -74
  87. package/src/layout/AppMenuDrawer.css +71 -71
  88. package/src/layout/AppMenuDrawer.tsx +122 -122
  89. package/src/layout/DialogMotion.css +79 -79
  90. package/src/layout/ErrorBoundary.tsx +162 -162
  91. package/src/layout/PageContainer.css +48 -48
  92. package/src/layout/PageContainer.tsx +41 -41
  93. package/src/layout/ResponsiveDialog.css +86 -86
  94. package/src/layout/ResponsiveDialog.tsx +55 -55
  95. package/src/layout/index.tsx +70 -70
  96. package/src/link/Link.tsx +23 -23
  97. package/src/link/index.ts +1 -1
  98. package/src/mdi/Mdi.css +138 -138
  99. package/src/mdi/Mdi.test.tsx +91 -91
  100. package/src/mdi/Mdi.tsx +141 -141
  101. package/src/mdi/MdiConfirmCloseDialog.tsx +47 -47
  102. package/src/mdi/MdiContext.tsx +59 -59
  103. package/src/mdi/MdiDocumentContext.tsx +60 -60
  104. package/src/mdi/MdiPanel.tsx +61 -61
  105. package/src/mdi/MdiRestore.test.tsx +86 -86
  106. package/src/mdi/MdiTab.tsx +30 -30
  107. package/src/mdi/controller.test.ts +382 -382
  108. package/src/mdi/controller.ts +656 -656
  109. package/src/mdi/dockviewHost.ts +132 -132
  110. package/src/mdi/fakeHost.ts +200 -200
  111. package/src/mdi/host.ts +44 -44
  112. package/src/mdi/ids.test.ts +20 -20
  113. package/src/mdi/ids.ts +18 -18
  114. package/src/mdi/index.ts +31 -31
  115. package/src/mdi/layoutRestore.test.ts +156 -156
  116. package/src/mdi/layoutRestore.ts +311 -311
  117. package/src/mdi/layoutSpec.test.ts +143 -143
  118. package/src/mdi/layoutSpec.ts +214 -214
  119. package/src/mdi/layoutStore.test.ts +93 -93
  120. package/src/mdi/layoutStore.ts +99 -99
  121. package/src/mdi/memorySettingsStore.ts +21 -21
  122. package/src/mdi/registry.ts +34 -34
  123. package/src/mdi/testTypes.ts +37 -37
  124. package/src/mdi/theme.ts +22 -22
  125. package/src/mdi/types.ts +214 -214
  126. package/src/page/Page.css +57 -57
  127. package/src/page/PageBlock.css +64 -64
  128. package/src/page/PageBlock.tsx +93 -93
  129. package/src/page/PageHeader.css +88 -88
  130. package/src/page/PageHeader.tsx +115 -115
  131. package/src/page/PageTitle.css +5 -5
  132. package/src/page/PageTitle.tsx +21 -21
  133. package/src/page/index.ts +4 -4
  134. package/src/paper/Paper.tsx +52 -52
  135. package/src/progress/LinearProgress.css +121 -93
  136. package/src/progress/LinearProgress.tsx +106 -104
  137. package/src/progress/index.ts +1 -1
  138. package/src/report-downloader/ReportDownloader.css +67 -67
  139. package/src/report-downloader/components/StatusItem.tsx +87 -87
  140. package/src/report-downloader/components/StatusList.tsx +28 -28
  141. package/src/report-downloader/index.ts +41 -41
  142. package/src/report-downloader/status.tsx +92 -92
  143. package/src/sortable/DropIndicator.css +51 -51
  144. package/src/sortable/DropIndicator.tsx +27 -27
  145. package/src/sortable/SortableItemList.css +21 -21
  146. package/src/sortable/SortableItemList.tsx +264 -264
  147. package/src/sortable/index.ts +8 -8
  148. package/src/sortable/reorderSortOrder.ts +126 -126
  149. package/src/sortable/sortOrder.ts +101 -101
  150. package/src/sortable/types.ts +9 -9
  151. package/src/sortable/useSortableContainer.ts +53 -53
  152. package/src/sortable/useSortableItem.ts +95 -95
  153. package/src/sortable/useSortableList.ts +117 -117
  154. package/src/test/happy-dom-document-class.ts +24 -24
  155. package/src/test/setup.ts +27 -12
  156. package/src/theme/useDsColorScheme.ts +53 -53
  157. package/tsconfig.build.json +9 -9
  158. package/tsconfig.json +8 -8
  159. package/vitest.config.ts +10 -10
@@ -1,435 +1,435 @@
1
- import "./FilterBuilder.css";
2
-
3
- import { Button, Checkbox, Dialog, Heading } from "@digdir/designsystemet-react";
4
- import { XMarkIcon } from "@navikt/aksel-icons";
5
- import {
6
- canEditSavedFilter,
7
- canSetCrossDomain,
8
- canShareSavedFilter,
9
- createEmptyFilter,
10
- findSavedFilter,
11
- type FilterTree,
12
- isEmptyFilter,
13
- pruneFilter,
14
- type SavedFilter,
15
- } from "@olenbetong/appframe-core";
16
- import { type NamedFilterType, setNamedFilter, useFilterConversion, useSavedFilters } from "@olenbetong/appframe-react";
17
- import type { SaveFilterInput } from "@olenbetong/appframe-react";
18
- import type { DataObject } from "@olenbetong/appframe-data";
19
- import clsx from "clsx";
20
- import { type ReactNode, useCallback, useEffect, useState } from "react";
21
-
22
- import { FilterEditor } from "./FilterEditor.js";
23
- import { FilterNameDialog } from "./FilterNameDialog.js";
24
- import { FilterShareDialog } from "./FilterShareDialog.js";
25
- import { SavedFilterTree } from "./SavedFilterTree.js";
26
- import type { FilterEditorSize, GetFieldOptions } from "./types.js";
27
- import type { FieldMetadata } from "@olenbetong/appframe-core";
28
- import { getLocalizedString } from "../i18n.js";
29
-
30
- export type FilterBuilderProps = {
31
- /** The fields the user can filter on. Fields with `excludeFromFilter` are hidden. */
32
- fields: FieldMetadata[];
33
- /**
34
- * The view the filter applies to. Used both for conversion and, unless
35
- * `dbObjectId` is set, as the key saved filters are stored under.
36
- */
37
- viewName?: string;
38
- /** Overrides `viewName` as the key saved filters are stored under. */
39
- dbObjectId?: string;
40
- /** Loads the filters saved for a report instead of for a view. */
41
- reportId?: string;
42
- getFieldOptions?: GetFieldOptions;
43
- /**
44
- * `"dialog"` wraps the builder in a modal, `"inline"` renders it in place.
45
- * @default "dialog"
46
- */
47
- variant?: "dialog" | "inline";
48
- /** Whether the dialog is open. Ignored when `variant` is `"inline"`. */
49
- open?: boolean;
50
- /** Called when the dialog is dismissed, and after the filter is applied. */
51
- onClose?: () => void;
52
- /** The filter tree. Use together with `onChange` for a controlled component. */
53
- value?: FilterTree | null;
54
- /** The initial filter tree when uncontrolled. */
55
- defaultValue?: FilterTree | null;
56
- /** Called on every edit. */
57
- onChange?: (filter: FilterTree) => void;
58
- /**
59
- * Called when the user applies the filter. The tree is pruned, so incomplete
60
- * conditions are dropped and an empty filter is reported as `null`.
61
- */
62
- onApply?: (filter: FilterTree | null, filterString: string) => void;
63
- /**
64
- * Applies the filter to a data object when the user confirms. The filter is
65
- * written to a named slot, so it composes with other filter providers on the
66
- * same data object instead of overwriting them.
67
- */
68
- dataObject?: DataObject<any>;
69
- /**
70
- * Parameter the filter is applied to.
71
- * @default "filterObject"
72
- */
73
- filterType?: NamedFilterType;
74
- /**
75
- * Name of the slot the filter is applied to.
76
- * @default "filterBuilder"
77
- */
78
- slotName?: string;
79
- /**
80
- * Shows the filter string below the tree.
81
- * @default true
82
- */
83
- showFilterString?: boolean;
84
- /** Called whenever the filter string is reconverted. */
85
- onFilterStringChange?: (filterString: string) => void;
86
- /** Called when a saved filter is selected, and with `null` for "New Filter". */
87
- onSelect?: (filter: SavedFilter | null) => void;
88
- /**
89
- * Extra columns written along with the filter when it is saved. The report
90
- * launcher stores its header text, its hide-criteria flag and its parameter
91
- * values here.
92
- */
93
- saveValues?: SavedFilterValues;
94
- /**
95
- * Hides the OK/Cancel row, for callers that supply their own actions. The
96
- * saved-filter toolbar stays.
97
- */
98
- hideActions?: boolean;
99
- /**
100
- * Replaces the OK/Cancel buttons, so a caller's own actions share the row
101
- * with the buttons acting on the selected saved filter.
102
- */
103
- actions?: ReactNode;
104
- /**
105
- * Wraps the criteria editor, for callers that put it beside content of their
106
- * own — the report launcher puts it in a tab next to the report parameters.
107
- * Whatever is returned fills the column next to the saved-filter list.
108
- */
109
- renderMain?: (editor: ReactNode) => ReactNode;
110
- /** Hides the saved-filter list, leaving just the criteria editor. */
111
- hideSavedFilters?: boolean;
112
- className?: string;
113
- "data-size"?: FilterEditorSize;
114
- };
115
-
116
- /** The parts of a saved filter the builder writes on behalf of a caller. */
117
- export type SavedFilterValues = Pick<SaveFilterInput, "headerText" | "hideCriteria" | "parameters">;
118
-
119
- /**
120
- * The web port of the Windows filter builder: the saved-filter list, the
121
- * criteria editor and the save/share toolbar.
122
- *
123
- * Saved filters are stored as criteria strings, so selecting one round-trips
124
- * through the conversion endpoint to rebuild the tree, and saving converts the
125
- * tree back.
126
- *
127
- * @example
128
- * ```jsx
129
- * <FilterBuilder
130
- * open={open}
131
- * fields={dsPersons.getFields()}
132
- * viewName="aviw_Personnel_Persons"
133
- * dataObject={dsPersons}
134
- * onClose={() => setOpen(false)}
135
- * />
136
- * ```
137
- */
138
- export function FilterBuilder({
139
- fields,
140
- viewName,
141
- dbObjectId,
142
- reportId,
143
- getFieldOptions,
144
- variant = "dialog",
145
- open = true,
146
- onClose,
147
- value,
148
- defaultValue,
149
- onChange,
150
- onApply,
151
- dataObject,
152
- filterType = "filterObject",
153
- slotName = "filterBuilder",
154
- showFilterString = true,
155
- onFilterStringChange,
156
- onSelect,
157
- saveValues,
158
- hideActions,
159
- actions,
160
- renderMain,
161
- hideSavedFilters,
162
- className,
163
- "data-size": size = "sm",
164
- }: FilterBuilderProps) {
165
- let resolvedId = dbObjectId ?? viewName;
166
- let { mine, shared, filters, loading, save, rename, remove, setCrossDomain } = useSavedFilters({
167
- dbObjectId: reportId ? undefined : resolvedId,
168
- reportId,
169
- });
170
-
171
- let [uncontrolled, setUncontrolled] = useState<FilterTree>(() => defaultValue ?? createEmptyFilter());
172
- let isControlled = value !== undefined;
173
- let filter = isControlled ? (value ?? createEmptyFilter()) : uncontrolled;
174
-
175
- let [selectedId, setSelectedId] = useState<number | null>(null);
176
- let [dirty, setDirty] = useState(false);
177
- let [saving, setSaving] = useState(false);
178
- let [sharing, setSharing] = useState(false);
179
- let [error, setError] = useState<string | null>(null);
180
-
181
- let { filterString, isConverting, parseFilterString } = useFilterConversion(filter, { viewName });
182
- let selected = findSavedFilter(filters, selectedId);
183
-
184
- useEffect(() => {
185
- onFilterStringChange?.(filterString);
186
- }, [filterString, onFilterStringChange]);
187
-
188
- let update = useCallback(
189
- (next: FilterTree) => {
190
- if (!isControlled) setUncontrolled(next);
191
- onChange?.(next);
192
- setDirty(true);
193
- },
194
- [isControlled, onChange],
195
- );
196
-
197
- function applyFilter(next: FilterTree, markClean: boolean) {
198
- if (!isControlled) setUncontrolled(next);
199
- onChange?.(next);
200
- if (markClean) setDirty(false);
201
- }
202
-
203
- async function handleSelect(filterId: number | null) {
204
- setSelectedId(filterId);
205
- setError(null);
206
-
207
- if (filterId === null) {
208
- applyFilter(createEmptyFilter(), true);
209
- onSelect?.(null);
210
-
211
- return;
212
- }
213
-
214
- let savedFilter = findSavedFilter(filters, filterId);
215
- if (!savedFilter) return;
216
-
217
- onSelect?.(savedFilter);
218
-
219
- // Filters are stored as criteria strings, so the tree has to be rebuilt.
220
- let parsed = await parseFilterString(savedFilter.criteria);
221
- applyFilter(parsed ?? createEmptyFilter(), true);
222
- }
223
-
224
- async function handleSave(name: string) {
225
- setSaving(false);
226
- setError(null);
227
-
228
- try {
229
- // Saving under an existing name of the user's own replaces that
230
- // filter rather than creating a duplicate.
231
- let existing = mine.find((candidate) => candidate.name === name);
232
- let saved = await save({
233
- ...saveValues,
234
- filterId: existing?.filterId ?? null,
235
- name,
236
- criteria: filterString,
237
- crossDomain: existing?.crossDomain ?? undefined,
238
- });
239
-
240
- if (saved) setSelectedId(saved.filterId);
241
- setDirty(false);
242
- } catch (cause) {
243
- setError(String((cause as Error)?.message ?? cause));
244
- }
245
- }
246
-
247
- async function handleOverwrite() {
248
- if (!selected) return;
249
-
250
- setError(null);
251
-
252
- try {
253
- await save({ ...saveValues, filterId: selected.filterId, name: selected.name, criteria: filterString });
254
- setDirty(false);
255
- } catch (cause) {
256
- setError(String((cause as Error)?.message ?? cause));
257
- }
258
- }
259
-
260
- function handleRename(savedFilter: SavedFilter) {
261
- let name = globalThis.prompt?.(getLocalizedString("Filter name"), savedFilter.name);
262
- if (name?.trim()) void rename(savedFilter.filterId, name.trim());
263
- }
264
-
265
- function handleDelete(savedFilter: SavedFilter) {
266
- let message = getLocalizedString("Delete the filter {0}?").replace("{0}", savedFilter.name);
267
- if (!globalThis.confirm?.(message)) return;
268
-
269
- void remove(savedFilter.filterId).then(() => {
270
- if (savedFilter.filterId === selectedId) void handleSelect(null);
271
- });
272
- }
273
-
274
- function handleApply() {
275
- let pruned = pruneFilter(filter);
276
-
277
- if (dataObject) {
278
- setNamedFilter(dataObject, slotName, pruned, { type: filterType });
279
- }
280
-
281
- onApply?.(pruned, filterString);
282
- onClose?.();
283
- }
284
-
285
- let isEmpty = isEmptyFilter(filter);
286
- let canOverwrite = Boolean(selected) && canEditSavedFilter(selected as SavedFilter) && dirty && !isEmpty;
287
-
288
- let editor = (
289
- <FilterEditor
290
- fields={fields}
291
- value={filter}
292
- viewName={viewName}
293
- getFieldOptions={getFieldOptions}
294
- showFilterString={showFilterString}
295
- data-size={size}
296
- onChange={update}
297
- />
298
- );
299
-
300
- let content = (
301
- <div
302
- className={clsx("ObFilterBuilder-root", hideSavedFilters && "ObFilterBuilder-root--noSavedFilters", className)}
303
- data-size={size}
304
- >
305
- {!hideSavedFilters && (
306
- <div className="ObFilterBuilder-sidebar">
307
- <SavedFilterTree
308
- mine={mine}
309
- shared={shared}
310
- value={selectedId}
311
- dirty={dirty}
312
- loading={loading}
313
- data-size={size}
314
- onChange={(filterId) => void handleSelect(filterId)}
315
- onRename={handleRename}
316
- onDelete={handleDelete}
317
- />
318
- </div>
319
- )}
320
- <div className="ObFilterBuilder-main">{renderMain ? renderMain(editor) : editor}</div>
321
- {error && (
322
- <p className="ObFilterBuilder-error" role="alert">
323
- {error}
324
- </p>
325
- )}
326
- <div className="ObFilterBuilder-footer">
327
- {!hideSavedFilters && (
328
- <div className="ObFilterBuilder-toolbar">
329
- <Button
330
- type="button"
331
- variant="secondary"
332
- data-size={size}
333
- disabled={!selected || !canShareSavedFilter(selected)}
334
- onClick={() => setSharing(true)}
335
- >
336
- {getLocalizedString("Sharing...")}
337
- </Button>
338
- <Button
339
- type="button"
340
- variant="secondary"
341
- data-size={size}
342
- disabled={isEmpty || isConverting}
343
- onClick={() => setSaving(true)}
344
- >
345
- {getLocalizedString("Save as")}
346
- </Button>
347
- <Button
348
- type="button"
349
- variant="secondary"
350
- data-size={size}
351
- disabled={!canOverwrite || isConverting}
352
- onClick={() => void handleOverwrite()}
353
- >
354
- {getLocalizedString("Save")}
355
- </Button>
356
- <Checkbox
357
- data-size={size}
358
- label={getLocalizedString("All Domains")}
359
- checked={selected?.crossDomain ?? false}
360
- disabled={!selected || !canSetCrossDomain(selected)}
361
- onChange={(event) => {
362
- if (selected) void setCrossDomain(selected.filterId, event.currentTarget.checked);
363
- }}
364
- />
365
- </div>
366
- )}
367
- {!hideActions && (
368
- <div className="ObFilterBuilder-actions">
369
- {actions ?? (
370
- <>
371
- <Button type="button" data-size={size} onClick={handleApply}>
372
- {getLocalizedString("OK")}
373
- </Button>
374
- <Button type="button" variant="secondary" data-size={size} onClick={onClose}>
375
- {getLocalizedString("Cancel")}
376
- </Button>
377
- </>
378
- )}
379
- </div>
380
- )}
381
- </div>
382
- <FilterNameDialog
383
- open={saving}
384
- defaultName={selected?.name ?? ""}
385
- existingNames={mine.map((candidate) => candidate.name)}
386
- data-size={size}
387
- onCancel={() => setSaving(false)}
388
- onSubmit={(name) => void handleSave(name)}
389
- />
390
- <FilterShareDialog
391
- open={sharing}
392
- filterId={selectedId}
393
- filterName={selected?.name}
394
- data-size={size}
395
- onClose={() => setSharing(false)}
396
- />
397
- </div>
398
- );
399
-
400
- if (variant === "inline") return content;
401
-
402
- return (
403
- <Dialog
404
- open={open}
405
- closedby="any"
406
- closeButton={false}
407
- data-size={size}
408
- className="ObFilterBuilder-dialog"
409
- onClose={onClose}
410
- >
411
- {/*
412
- * `Dialog`'s own close button is a floated first child of the dialog,
413
- * which a flex layout takes out of its float and stacks above the
414
- * heading. Rendering it in the header instead keeps it aligned.
415
- */}
416
- <Dialog.Block className="ObFilterBuilder-dialogHeader">
417
- <Heading level={2} data-size="xs">
418
- {getLocalizedString("Edit filter")}
419
- </Heading>
420
- <Button
421
- type="button"
422
- variant="tertiary"
423
- data-color="neutral"
424
- data-size={size}
425
- icon
426
- aria-label={getLocalizedString("Close")}
427
- onClick={onClose}
428
- >
429
- <XMarkIcon aria-hidden />
430
- </Button>
431
- </Dialog.Block>
432
- <Dialog.Block className="ObFilterBuilder-dialogBody">{content}</Dialog.Block>
433
- </Dialog>
434
- );
435
- }
1
+ import "./FilterBuilder.css";
2
+
3
+ import { Button, Checkbox, Dialog, Heading } from "@digdir/designsystemet-react";
4
+ import { XMarkIcon } from "@navikt/aksel-icons";
5
+ import {
6
+ canEditSavedFilter,
7
+ canSetCrossDomain,
8
+ canShareSavedFilter,
9
+ createEmptyFilter,
10
+ findSavedFilter,
11
+ type FilterTree,
12
+ isEmptyFilter,
13
+ pruneFilter,
14
+ type SavedFilter,
15
+ } from "@olenbetong/appframe-core";
16
+ import { type NamedFilterType, setNamedFilter, useFilterConversion, useSavedFilters } from "@olenbetong/appframe-react";
17
+ import type { SaveFilterInput } from "@olenbetong/appframe-react";
18
+ import type { DataObject } from "@olenbetong/appframe-data";
19
+ import clsx from "clsx";
20
+ import { type ReactNode, useCallback, useEffect, useState } from "react";
21
+
22
+ import { FilterEditor } from "./FilterEditor.js";
23
+ import { FilterNameDialog } from "./FilterNameDialog.js";
24
+ import { FilterShareDialog } from "./FilterShareDialog.js";
25
+ import { SavedFilterTree } from "./SavedFilterTree.js";
26
+ import type { FilterEditorSize, GetFieldOptions } from "./types.js";
27
+ import type { FieldMetadata } from "@olenbetong/appframe-core";
28
+ import { getLocalizedString } from "../i18n.js";
29
+
30
+ export type FilterBuilderProps = {
31
+ /** The fields the user can filter on. Fields with `excludeFromFilter` are hidden. */
32
+ fields: FieldMetadata[];
33
+ /**
34
+ * The view the filter applies to. Used both for conversion and, unless
35
+ * `dbObjectId` is set, as the key saved filters are stored under.
36
+ */
37
+ viewName?: string;
38
+ /** Overrides `viewName` as the key saved filters are stored under. */
39
+ dbObjectId?: string;
40
+ /** Loads the filters saved for a report instead of for a view. */
41
+ reportId?: string;
42
+ getFieldOptions?: GetFieldOptions;
43
+ /**
44
+ * `"dialog"` wraps the builder in a modal, `"inline"` renders it in place.
45
+ * @default "dialog"
46
+ */
47
+ variant?: "dialog" | "inline";
48
+ /** Whether the dialog is open. Ignored when `variant` is `"inline"`. */
49
+ open?: boolean;
50
+ /** Called when the dialog is dismissed, and after the filter is applied. */
51
+ onClose?: () => void;
52
+ /** The filter tree. Use together with `onChange` for a controlled component. */
53
+ value?: FilterTree | null;
54
+ /** The initial filter tree when uncontrolled. */
55
+ defaultValue?: FilterTree | null;
56
+ /** Called on every edit. */
57
+ onChange?: (filter: FilterTree) => void;
58
+ /**
59
+ * Called when the user applies the filter. The tree is pruned, so incomplete
60
+ * conditions are dropped and an empty filter is reported as `null`.
61
+ */
62
+ onApply?: (filter: FilterTree | null, filterString: string) => void;
63
+ /**
64
+ * Applies the filter to a data object when the user confirms. The filter is
65
+ * written to a named slot, so it composes with other filter providers on the
66
+ * same data object instead of overwriting them.
67
+ */
68
+ dataObject?: DataObject<any>;
69
+ /**
70
+ * Parameter the filter is applied to.
71
+ * @default "filterObject"
72
+ */
73
+ filterType?: NamedFilterType;
74
+ /**
75
+ * Name of the slot the filter is applied to.
76
+ * @default "filterBuilder"
77
+ */
78
+ slotName?: string;
79
+ /**
80
+ * Shows the filter string below the tree.
81
+ * @default true
82
+ */
83
+ showFilterString?: boolean;
84
+ /** Called whenever the filter string is reconverted. */
85
+ onFilterStringChange?: (filterString: string) => void;
86
+ /** Called when a saved filter is selected, and with `null` for "New Filter". */
87
+ onSelect?: (filter: SavedFilter | null) => void;
88
+ /**
89
+ * Extra columns written along with the filter when it is saved. The report
90
+ * launcher stores its header text, its hide-criteria flag and its parameter
91
+ * values here.
92
+ */
93
+ saveValues?: SavedFilterValues;
94
+ /**
95
+ * Hides the OK/Cancel row, for callers that supply their own actions. The
96
+ * saved-filter toolbar stays.
97
+ */
98
+ hideActions?: boolean;
99
+ /**
100
+ * Replaces the OK/Cancel buttons, so a caller's own actions share the row
101
+ * with the buttons acting on the selected saved filter.
102
+ */
103
+ actions?: ReactNode;
104
+ /**
105
+ * Wraps the criteria editor, for callers that put it beside content of their
106
+ * own — the report launcher puts it in a tab next to the report parameters.
107
+ * Whatever is returned fills the column next to the saved-filter list.
108
+ */
109
+ renderMain?: (editor: ReactNode) => ReactNode;
110
+ /** Hides the saved-filter list, leaving just the criteria editor. */
111
+ hideSavedFilters?: boolean;
112
+ className?: string;
113
+ "data-size"?: FilterEditorSize;
114
+ };
115
+
116
+ /** The parts of a saved filter the builder writes on behalf of a caller. */
117
+ export type SavedFilterValues = Pick<SaveFilterInput, "headerText" | "hideCriteria" | "parameters">;
118
+
119
+ /**
120
+ * The web port of the Windows filter builder: the saved-filter list, the
121
+ * criteria editor and the save/share toolbar.
122
+ *
123
+ * Saved filters are stored as criteria strings, so selecting one round-trips
124
+ * through the conversion endpoint to rebuild the tree, and saving converts the
125
+ * tree back.
126
+ *
127
+ * @example
128
+ * ```jsx
129
+ * <FilterBuilder
130
+ * open={open}
131
+ * fields={dsPersons.getFields()}
132
+ * viewName="aviw_Personnel_Persons"
133
+ * dataObject={dsPersons}
134
+ * onClose={() => setOpen(false)}
135
+ * />
136
+ * ```
137
+ */
138
+ export function FilterBuilder({
139
+ fields,
140
+ viewName,
141
+ dbObjectId,
142
+ reportId,
143
+ getFieldOptions,
144
+ variant = "dialog",
145
+ open = true,
146
+ onClose,
147
+ value,
148
+ defaultValue,
149
+ onChange,
150
+ onApply,
151
+ dataObject,
152
+ filterType = "filterObject",
153
+ slotName = "filterBuilder",
154
+ showFilterString = true,
155
+ onFilterStringChange,
156
+ onSelect,
157
+ saveValues,
158
+ hideActions,
159
+ actions,
160
+ renderMain,
161
+ hideSavedFilters,
162
+ className,
163
+ "data-size": size = "sm",
164
+ }: FilterBuilderProps) {
165
+ let resolvedId = dbObjectId ?? viewName;
166
+ let { mine, shared, filters, loading, save, rename, remove, setCrossDomain } = useSavedFilters({
167
+ dbObjectId: reportId ? undefined : resolvedId,
168
+ reportId,
169
+ });
170
+
171
+ let [uncontrolled, setUncontrolled] = useState<FilterTree>(() => defaultValue ?? createEmptyFilter());
172
+ let isControlled = value !== undefined;
173
+ let filter = isControlled ? (value ?? createEmptyFilter()) : uncontrolled;
174
+
175
+ let [selectedId, setSelectedId] = useState<number | null>(null);
176
+ let [dirty, setDirty] = useState(false);
177
+ let [saving, setSaving] = useState(false);
178
+ let [sharing, setSharing] = useState(false);
179
+ let [error, setError] = useState<string | null>(null);
180
+
181
+ let { filterString, isConverting, parseFilterString } = useFilterConversion(filter, { viewName });
182
+ let selected = findSavedFilter(filters, selectedId);
183
+
184
+ useEffect(() => {
185
+ onFilterStringChange?.(filterString);
186
+ }, [filterString, onFilterStringChange]);
187
+
188
+ let update = useCallback(
189
+ (next: FilterTree) => {
190
+ if (!isControlled) setUncontrolled(next);
191
+ onChange?.(next);
192
+ setDirty(true);
193
+ },
194
+ [isControlled, onChange],
195
+ );
196
+
197
+ function applyFilter(next: FilterTree, markClean: boolean) {
198
+ if (!isControlled) setUncontrolled(next);
199
+ onChange?.(next);
200
+ if (markClean) setDirty(false);
201
+ }
202
+
203
+ async function handleSelect(filterId: number | null) {
204
+ setSelectedId(filterId);
205
+ setError(null);
206
+
207
+ if (filterId === null) {
208
+ applyFilter(createEmptyFilter(), true);
209
+ onSelect?.(null);
210
+
211
+ return;
212
+ }
213
+
214
+ let savedFilter = findSavedFilter(filters, filterId);
215
+ if (!savedFilter) return;
216
+
217
+ onSelect?.(savedFilter);
218
+
219
+ // Filters are stored as criteria strings, so the tree has to be rebuilt.
220
+ let parsed = await parseFilterString(savedFilter.criteria);
221
+ applyFilter(parsed ?? createEmptyFilter(), true);
222
+ }
223
+
224
+ async function handleSave(name: string) {
225
+ setSaving(false);
226
+ setError(null);
227
+
228
+ try {
229
+ // Saving under an existing name of the user's own replaces that
230
+ // filter rather than creating a duplicate.
231
+ let existing = mine.find((candidate) => candidate.name === name);
232
+ let saved = await save({
233
+ ...saveValues,
234
+ filterId: existing?.filterId ?? null,
235
+ name,
236
+ criteria: filterString,
237
+ crossDomain: existing?.crossDomain ?? undefined,
238
+ });
239
+
240
+ if (saved) setSelectedId(saved.filterId);
241
+ setDirty(false);
242
+ } catch (cause) {
243
+ setError(String((cause as Error)?.message ?? cause));
244
+ }
245
+ }
246
+
247
+ async function handleOverwrite() {
248
+ if (!selected) return;
249
+
250
+ setError(null);
251
+
252
+ try {
253
+ await save({ ...saveValues, filterId: selected.filterId, name: selected.name, criteria: filterString });
254
+ setDirty(false);
255
+ } catch (cause) {
256
+ setError(String((cause as Error)?.message ?? cause));
257
+ }
258
+ }
259
+
260
+ function handleRename(savedFilter: SavedFilter) {
261
+ let name = globalThis.prompt?.(getLocalizedString("Filter name"), savedFilter.name);
262
+ if (name?.trim()) void rename(savedFilter.filterId, name.trim());
263
+ }
264
+
265
+ function handleDelete(savedFilter: SavedFilter) {
266
+ let message = getLocalizedString("Delete the filter {0}?").replace("{0}", savedFilter.name);
267
+ if (!globalThis.confirm?.(message)) return;
268
+
269
+ void remove(savedFilter.filterId).then(() => {
270
+ if (savedFilter.filterId === selectedId) void handleSelect(null);
271
+ });
272
+ }
273
+
274
+ function handleApply() {
275
+ let pruned = pruneFilter(filter);
276
+
277
+ if (dataObject) {
278
+ setNamedFilter(dataObject, slotName, pruned, { type: filterType });
279
+ }
280
+
281
+ onApply?.(pruned, filterString);
282
+ onClose?.();
283
+ }
284
+
285
+ let isEmpty = isEmptyFilter(filter);
286
+ let canOverwrite = Boolean(selected) && canEditSavedFilter(selected as SavedFilter) && dirty && !isEmpty;
287
+
288
+ let editor = (
289
+ <FilterEditor
290
+ fields={fields}
291
+ value={filter}
292
+ viewName={viewName}
293
+ getFieldOptions={getFieldOptions}
294
+ showFilterString={showFilterString}
295
+ data-size={size}
296
+ onChange={update}
297
+ />
298
+ );
299
+
300
+ let content = (
301
+ <div
302
+ className={clsx("ObFilterBuilder-root", hideSavedFilters && "ObFilterBuilder-root--noSavedFilters", className)}
303
+ data-size={size}
304
+ >
305
+ {!hideSavedFilters && (
306
+ <div className="ObFilterBuilder-sidebar">
307
+ <SavedFilterTree
308
+ mine={mine}
309
+ shared={shared}
310
+ value={selectedId}
311
+ dirty={dirty}
312
+ loading={loading}
313
+ data-size={size}
314
+ onChange={(filterId) => void handleSelect(filterId)}
315
+ onRename={handleRename}
316
+ onDelete={handleDelete}
317
+ />
318
+ </div>
319
+ )}
320
+ <div className="ObFilterBuilder-main">{renderMain ? renderMain(editor) : editor}</div>
321
+ {error && (
322
+ <p className="ObFilterBuilder-error" role="alert">
323
+ {error}
324
+ </p>
325
+ )}
326
+ <div className="ObFilterBuilder-footer">
327
+ {!hideSavedFilters && (
328
+ <div className="ObFilterBuilder-toolbar">
329
+ <Button
330
+ type="button"
331
+ variant="secondary"
332
+ data-size={size}
333
+ disabled={!selected || !canShareSavedFilter(selected)}
334
+ onClick={() => setSharing(true)}
335
+ >
336
+ {getLocalizedString("Sharing...")}
337
+ </Button>
338
+ <Button
339
+ type="button"
340
+ variant="secondary"
341
+ data-size={size}
342
+ disabled={isEmpty || isConverting}
343
+ onClick={() => setSaving(true)}
344
+ >
345
+ {getLocalizedString("Save as")}
346
+ </Button>
347
+ <Button
348
+ type="button"
349
+ variant="secondary"
350
+ data-size={size}
351
+ disabled={!canOverwrite || isConverting}
352
+ onClick={() => void handleOverwrite()}
353
+ >
354
+ {getLocalizedString("Save")}
355
+ </Button>
356
+ <Checkbox
357
+ data-size={size}
358
+ label={getLocalizedString("All Domains")}
359
+ checked={selected?.crossDomain ?? false}
360
+ disabled={!selected || !canSetCrossDomain(selected)}
361
+ onChange={(event) => {
362
+ if (selected) void setCrossDomain(selected.filterId, event.currentTarget.checked);
363
+ }}
364
+ />
365
+ </div>
366
+ )}
367
+ {!hideActions && (
368
+ <div className="ObFilterBuilder-actions">
369
+ {actions ?? (
370
+ <>
371
+ <Button type="button" data-size={size} onClick={handleApply}>
372
+ {getLocalizedString("OK")}
373
+ </Button>
374
+ <Button type="button" variant="secondary" data-size={size} onClick={onClose}>
375
+ {getLocalizedString("Cancel")}
376
+ </Button>
377
+ </>
378
+ )}
379
+ </div>
380
+ )}
381
+ </div>
382
+ <FilterNameDialog
383
+ open={saving}
384
+ defaultName={selected?.name ?? ""}
385
+ existingNames={mine.map((candidate) => candidate.name)}
386
+ data-size={size}
387
+ onCancel={() => setSaving(false)}
388
+ onSubmit={(name) => void handleSave(name)}
389
+ />
390
+ <FilterShareDialog
391
+ open={sharing}
392
+ filterId={selectedId}
393
+ filterName={selected?.name}
394
+ data-size={size}
395
+ onClose={() => setSharing(false)}
396
+ />
397
+ </div>
398
+ );
399
+
400
+ if (variant === "inline") return content;
401
+
402
+ return (
403
+ <Dialog
404
+ open={open}
405
+ closedby="any"
406
+ closeButton={false}
407
+ data-size={size}
408
+ className="ObFilterBuilder-dialog"
409
+ onClose={onClose}
410
+ >
411
+ {/*
412
+ * `Dialog`'s own close button is a floated first child of the dialog,
413
+ * which a flex layout takes out of its float and stacks above the
414
+ * heading. Rendering it in the header instead keeps it aligned.
415
+ */}
416
+ <Dialog.Block className="ObFilterBuilder-dialogHeader">
417
+ <Heading level={2} data-size="xs">
418
+ {getLocalizedString("Edit filter")}
419
+ </Heading>
420
+ <Button
421
+ type="button"
422
+ variant="tertiary"
423
+ data-color="neutral"
424
+ data-size={size}
425
+ icon
426
+ aria-label={getLocalizedString("Close")}
427
+ onClick={onClose}
428
+ >
429
+ <XMarkIcon aria-hidden />
430
+ </Button>
431
+ </Dialog.Block>
432
+ <Dialog.Block className="ObFilterBuilder-dialogBody">{content}</Dialog.Block>
433
+ </Dialog>
434
+ );
435
+ }