@olenbetong/synergi-react 2.9.0 → 3.0.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 (113) hide show
  1. package/es/chrome/AppShell/index.d.ts +8 -0
  2. package/es/chrome/AppShell/index.js +10 -130
  3. package/es/components/ImageEditor/ImageEditor.css +10 -0
  4. package/es/components/ImageEditor/index.d.ts +1 -0
  5. package/es/components/ImageEditor/index.js +1 -0
  6. package/es/components/ImageEditor/plugins/cropPlugin/CropOverlay.js +27 -5
  7. package/es/components/ImageEditor/plugins/cropPlugin/CropToolbar.js +4 -3
  8. package/es/components/ImageEditor/plugins/cropPlugin/useCropTool.d.ts +20 -3
  9. package/es/components/ImageEditor/plugins/cropPlugin/useCropTool.js +216 -33
  10. package/es/components/ImageEditor/plugins/zoomPlugin/ZoomContext.d.ts +5 -0
  11. package/es/components/ImageEditor/plugins/zoomPlugin/ZoomContext.js +7 -0
  12. package/es/components/ImageEditor/useEdgeDetection.d.ts +0 -2
  13. package/es/components/ImageEditor/useEdgeDetection.js +11 -30
  14. package/es/components/ImageEditor/useOpenCV.d.ts +26 -1
  15. package/es/components/ImageEditor/useOpenCV.js +108 -42
  16. package/es/components/SplitContainer/index.js +2 -4
  17. package/es/filter/ChipListInput.d.ts +13 -0
  18. package/es/filter/ChipListInput.js +34 -0
  19. package/es/filter/FilterBuilder.css +152 -0
  20. package/es/filter/FilterBuilder.d.ts +115 -0
  21. package/es/filter/FilterBuilder.js +146 -0
  22. package/es/filter/FilterBuilder.test.d.ts +1 -0
  23. package/es/filter/FilterBuilder.test.js +120 -0
  24. package/es/filter/FilterEditor.css +231 -0
  25. package/es/filter/FilterEditor.d.ts +17 -0
  26. package/es/filter/FilterEditor.js +38 -0
  27. package/es/filter/FilterEditor.test.d.ts +1 -0
  28. package/es/filter/FilterEditor.test.js +183 -0
  29. package/es/filter/FilterGroupEditor.d.ts +22 -0
  30. package/es/filter/FilterGroupEditor.js +34 -0
  31. package/es/filter/FilterNameDialog.css +22 -0
  32. package/es/filter/FilterNameDialog.d.ts +18 -0
  33. package/es/filter/FilterNameDialog.js +32 -0
  34. package/es/filter/FilterRow.d.ts +14 -0
  35. package/es/filter/FilterRow.js +32 -0
  36. package/es/filter/FilterShareDialog.css +28 -0
  37. package/es/filter/FilterShareDialog.d.ts +23 -0
  38. package/es/filter/FilterShareDialog.js +63 -0
  39. package/es/filter/FilterStringField.d.ts +15 -0
  40. package/es/filter/FilterStringField.js +37 -0
  41. package/es/filter/FilterValueEditor.d.ts +16 -0
  42. package/es/filter/FilterValueEditor.js +85 -0
  43. package/es/filter/SavedFilterTree.css +107 -0
  44. package/es/filter/SavedFilterTree.d.ts +45 -0
  45. package/es/filter/SavedFilterTree.js +44 -0
  46. package/es/filter/SavedFilterTree.test.d.ts +1 -0
  47. package/es/filter/SavedFilterTree.test.js +75 -0
  48. package/es/filter/index.d.ts +11 -0
  49. package/es/filter/index.js +10 -0
  50. package/es/filter/types.d.ts +34 -0
  51. package/es/filter/types.js +1 -0
  52. package/es/index.d.ts +2 -1
  53. package/es/index.js +6 -1
  54. package/es/mui/MuiThemeProvider.d.ts +24 -0
  55. package/es/mui/MuiThemeProvider.js +152 -0
  56. package/es/mui/index.d.ts +1 -0
  57. package/es/mui/index.js +1 -0
  58. package/es/report/ReportLauncher.css +147 -0
  59. package/es/report/ReportLauncher.d.ts +55 -0
  60. package/es/report/ReportLauncher.js +142 -0
  61. package/es/report/ReportLauncher.test.d.ts +1 -0
  62. package/es/report/ReportLauncher.test.js +231 -0
  63. package/es/report/ReportParameters.css +29 -0
  64. package/es/report/ReportParameters.d.ts +46 -0
  65. package/es/report/ReportParameters.js +65 -0
  66. package/es/report/ReportParameters.test.d.ts +1 -0
  67. package/es/report/ReportParameters.test.js +84 -0
  68. package/es/report/index.d.ts +2 -0
  69. package/es/report/index.js +2 -0
  70. package/es/test/setup.d.ts +1 -0
  71. package/es/test/setup.js +6 -0
  72. package/package.json +22 -7
  73. package/src/chrome/AppShell/index.tsx +34 -171
  74. package/src/components/ImageEditor/ImageEditor.css +10 -0
  75. package/src/components/ImageEditor/index.ts +1 -0
  76. package/src/components/ImageEditor/plugins/cropPlugin/CropOverlay.tsx +66 -20
  77. package/src/components/ImageEditor/plugins/cropPlugin/CropToolbar.tsx +19 -3
  78. package/src/components/ImageEditor/plugins/cropPlugin/useCropTool.ts +266 -39
  79. package/src/components/ImageEditor/plugins/zoomPlugin/ZoomContext.tsx +8 -0
  80. package/src/components/ImageEditor/useEdgeDetection.ts +11 -51
  81. package/src/components/ImageEditor/useOpenCV.ts +112 -62
  82. package/src/components/SplitContainer/index.tsx +3 -4
  83. package/src/filter/ChipListInput.tsx +79 -0
  84. package/src/filter/FilterBuilder.css +152 -0
  85. package/src/filter/FilterBuilder.test.tsx +153 -0
  86. package/src/filter/FilterBuilder.tsx +435 -0
  87. package/src/filter/FilterEditor.css +231 -0
  88. package/src/filter/FilterEditor.test.tsx +259 -0
  89. package/src/filter/FilterEditor.tsx +74 -0
  90. package/src/filter/FilterGroupEditor.tsx +160 -0
  91. package/src/filter/FilterNameDialog.css +22 -0
  92. package/src/filter/FilterNameDialog.tsx +81 -0
  93. package/src/filter/FilterRow.tsx +117 -0
  94. package/src/filter/FilterShareDialog.css +28 -0
  95. package/src/filter/FilterShareDialog.tsx +201 -0
  96. package/src/filter/FilterStringField.tsx +77 -0
  97. package/src/filter/FilterValueEditor.tsx +220 -0
  98. package/src/filter/SavedFilterTree.css +107 -0
  99. package/src/filter/SavedFilterTree.test.tsx +94 -0
  100. package/src/filter/SavedFilterTree.tsx +222 -0
  101. package/src/filter/index.ts +11 -0
  102. package/src/filter/types.ts +38 -0
  103. package/src/index.ts +39 -1
  104. package/src/mui/MuiThemeProvider.tsx +174 -0
  105. package/src/mui/index.ts +1 -0
  106. package/src/report/ReportLauncher.css +147 -0
  107. package/src/report/ReportLauncher.test.tsx +281 -0
  108. package/src/report/ReportLauncher.tsx +421 -0
  109. package/src/report/ReportParameters.css +29 -0
  110. package/src/report/ReportParameters.test.tsx +133 -0
  111. package/src/report/ReportParameters.tsx +198 -0
  112. package/src/report/index.ts +2 -0
  113. package/src/test/setup.ts +8 -0
@@ -1,12 +1,10 @@
1
1
  import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
2
2
  import "./index.css";
3
+ import { createSettingsStore } from "@olenbetong/appframe-react";
3
4
  import clsx from "clsx";
4
- import localforage from "localforage";
5
5
  import { Children, forwardRef, useEffect, useRef, useState } from "react";
6
6
  const article = globalThis.af?.article?.id ?? globalThis.window?.location.pathname.substring(1).split("/")[0];
7
- const settingsStore = localforage.createInstance({
8
- name: `AfSplitContainers.${globalThis.af?.userSession.login ?? "anonymous"}`,
9
- });
7
+ const settingsStore = createSettingsStore(`AfSplitContainers.${globalThis.af?.userSession?.login ?? "anonymous"}`);
10
8
  const settingsCache = {};
11
9
  async function persistState(key, layoutVersion, fixedSize) {
12
10
  if (fixedSize != null) {
@@ -0,0 +1,13 @@
1
+ export type ChipListInputProps = {
2
+ value: string[];
3
+ onChange: (value: string[]) => void;
4
+ readOnly?: boolean;
5
+ "aria-label": string;
6
+ "data-size"?: "sm" | "md" | "lg";
7
+ type?: "text" | "number" | "date" | "datetime-local";
8
+ };
9
+ /**
10
+ * Free text editor for the list operators. Values are added with Enter and
11
+ * rendered as removable chips.
12
+ */
13
+ export declare function ChipListInput({ value, onChange, readOnly, type, "aria-label": ariaLabel, "data-size": size, }: ChipListInputProps): import("react").JSX.Element;
@@ -0,0 +1,34 @@
1
+ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
2
+ import { ChipRemovable, Textfield } from "@digdir/designsystemet-react";
3
+ import { getLocalizedString } from "@olenbetong/appframe-core";
4
+ import { useState } from "react";
5
+ /**
6
+ * Free text editor for the list operators. Values are added with Enter and
7
+ * rendered as removable chips.
8
+ */
9
+ export function ChipListInput({ value, onChange, readOnly, type = "text", "aria-label": ariaLabel, "data-size": size, }) {
10
+ let [draft, setDraft] = useState("");
11
+ function commit() {
12
+ let trimmed = draft.trim();
13
+ if (!trimmed || value.includes(trimmed)) {
14
+ setDraft("");
15
+ return;
16
+ }
17
+ onChange([...value, trimmed]);
18
+ setDraft("");
19
+ }
20
+ function handleKeyDown(event) {
21
+ if (event.key === "Enter") {
22
+ // The editor is often rendered inside a dialog; committing a value
23
+ // must not submit or close it.
24
+ event.preventDefault();
25
+ commit();
26
+ }
27
+ else if (event.key === "Backspace" && draft === "" && value.length > 0) {
28
+ onChange(value.slice(0, -1));
29
+ }
30
+ }
31
+ return (_jsxs("div", { className: "ObFilterEditor-chipList", children: [value.map((item, index) => (_jsx(ChipRemovable
32
+ // Values are deduplicated on add, so the value is a stable key.
33
+ , { "data-size": size, disabled: readOnly, "aria-label": `${getLocalizedString("Remove")} ${item}`, onClick: () => onChange(value.filter((_, i) => i !== index)), children: item }, item))), !readOnly && (_jsx(Textfield, { className: "ObFilterEditor-chipListInput", "aria-label": ariaLabel, "data-size": size, type: type, value: draft, placeholder: getLocalizedString("Add value"), onChange: (event) => setDraft(event.target.value), onKeyDown: handleKeyDown, onBlur: commit }))] }));
34
+ }
@@ -0,0 +1,152 @@
1
+ /*
2
+ * Colours use the contextual `--ds-color-*` aliases so the builder follows the
3
+ * active colour scheme. Never add hex fallbacks.
4
+ */
5
+
6
+ .ObFilterBuilder-root {
7
+ display: grid;
8
+ gap: var(--ds-size-4);
9
+ /*
10
+ * The saved-filter list sits beside the editor. The buttons acting on the
11
+ * selected filter share the bottom row with OK/Cancel rather than being
12
+ * confined to the list's column, so they have room to stay on one line.
13
+ * On narrow viewports everything stacks.
14
+ */
15
+ grid-template:
16
+ "sidebar main" 1fr
17
+ "error error" auto
18
+ "footer footer" auto
19
+ / minmax(14rem, 22rem) minmax(0, 1fr);
20
+ block-size: 100%;
21
+ min-block-size: 0;
22
+ }
23
+
24
+ .ObFilterBuilder-sidebar {
25
+ grid-area: sidebar;
26
+ overflow: auto;
27
+ padding: var(--ds-size-2);
28
+ border: var(--ds-border-width-default) solid var(--ds-color-border-subtle);
29
+ border-radius: var(--ds-border-radius-md);
30
+ }
31
+
32
+ /*
33
+ * The editor manages its own scrolling — the conditions scroll, the filter
34
+ * string stays put — so this only has to hand it the available height. A caller
35
+ * that replaces the editor through `renderMain` gets the same treatment.
36
+ */
37
+ .ObFilterBuilder-main {
38
+ grid-area: main;
39
+ display: flex;
40
+ flex-direction: column;
41
+ gap: var(--ds-size-3);
42
+ min-inline-size: 0;
43
+ min-block-size: 0;
44
+ }
45
+
46
+ .ObFilterBuilder-main > * {
47
+ flex: 1 1 auto;
48
+ min-inline-size: 0;
49
+ min-block-size: 0;
50
+ }
51
+
52
+ .ObFilterBuilder-error {
53
+ grid-area: error;
54
+ margin: 0;
55
+ color: var(--ds-color-danger-text-default);
56
+ }
57
+
58
+ .ObFilterBuilder-footer {
59
+ grid-area: footer;
60
+ display: flex;
61
+ flex-wrap: wrap;
62
+ align-items: center;
63
+ justify-content: space-between;
64
+ gap: var(--ds-size-4);
65
+ }
66
+
67
+ .ObFilterBuilder-toolbar,
68
+ .ObFilterBuilder-actions {
69
+ display: flex;
70
+ flex-wrap: wrap;
71
+ align-items: center;
72
+ gap: var(--ds-size-2);
73
+ }
74
+
75
+ .ObFilterBuilder-actions {
76
+ margin-inline-start: auto;
77
+ }
78
+
79
+ /*
80
+ * Without the saved-filter list there are no buttons acting on one either, so
81
+ * the editor takes the full width.
82
+ */
83
+ .ObFilterBuilder-root--noSavedFilters {
84
+ grid-template:
85
+ "main" 1fr
86
+ "error" auto
87
+ "footer" auto
88
+ / minmax(0, 1fr);
89
+ }
90
+
91
+ /*
92
+ * `Dialog` caps itself at `--dsc-dialog-max-width` (40rem), so setting a width
93
+ * here would have no effect — the variable has to be raised instead. It needs
94
+ * to be wide enough that a condition — field, operator, value and the group
95
+ * buttons — fits on one line next to the saved-filter column.
96
+ */
97
+ .ObFilterBuilder-dialog {
98
+ --dsc-dialog-max-width: 84rem;
99
+ --dsc-dialog-max-height: 90dvh;
100
+ }
101
+
102
+ /*
103
+ * A fixed height keeps the dialog from resizing as conditions are added and
104
+ * removed, and gives the saved-filter column and the editor a height to fill.
105
+ * The dialog itself must not scroll — the body does — or the heading would
106
+ * scroll away and the OK/Cancel row would not stay at the bottom.
107
+ */
108
+ .ObFilterBuilder-dialog[open] {
109
+ display: flex;
110
+ flex-direction: column;
111
+ block-size: 48rem;
112
+ overflow: hidden;
113
+ }
114
+
115
+ /*
116
+ * The heading and the close button share the header row.
117
+ */
118
+ .ObFilterBuilder-dialogHeader {
119
+ display: flex;
120
+ align-items: center;
121
+ justify-content: space-between;
122
+ gap: var(--ds-size-2);
123
+ }
124
+
125
+ .ObFilterBuilder-dialogBody {
126
+ flex: 1 1 auto;
127
+ min-block-size: 0;
128
+ overflow: hidden;
129
+ }
130
+
131
+ @media (width < 48rem) {
132
+ .ObFilterBuilder-root:not(.ObFilterBuilder-root--noSavedFilters) {
133
+ grid-template:
134
+ "sidebar" auto
135
+ "main" 1fr
136
+ "error" auto
137
+ "footer" auto
138
+ / minmax(0, 1fr);
139
+ }
140
+
141
+ /*
142
+ * Stacked, the dialog body is the scroll container: the editor cannot give
143
+ * both the list and the conditions a useful height in the space left over.
144
+ */
145
+ .ObFilterBuilder-dialogBody {
146
+ overflow: auto;
147
+ }
148
+
149
+ .ObFilterBuilder-sidebar {
150
+ max-block-size: 12rem;
151
+ }
152
+ }
@@ -0,0 +1,115 @@
1
+ import "./FilterBuilder.css";
2
+ import { type FilterTree, type SavedFilter } from "@olenbetong/appframe-core";
3
+ import { type NamedFilterType } from "@olenbetong/appframe-react";
4
+ import type { SaveFilterInput } from "@olenbetong/appframe-react";
5
+ import type { DataObject } from "@olenbetong/appframe-data";
6
+ import { type ReactNode } from "react";
7
+ import type { FilterEditorSize, GetFieldOptions } from "./types.js";
8
+ import type { FieldMetadata } from "@olenbetong/appframe-core";
9
+ export type FilterBuilderProps = {
10
+ /** The fields the user can filter on. Fields with `excludeFromFilter` are hidden. */
11
+ fields: FieldMetadata[];
12
+ /**
13
+ * The view the filter applies to. Used both for conversion and, unless
14
+ * `dbObjectId` is set, as the key saved filters are stored under.
15
+ */
16
+ viewName?: string;
17
+ /** Overrides `viewName` as the key saved filters are stored under. */
18
+ dbObjectId?: string;
19
+ /** Loads the filters saved for a report instead of for a view. */
20
+ reportId?: string;
21
+ getFieldOptions?: GetFieldOptions;
22
+ /**
23
+ * `"dialog"` wraps the builder in a modal, `"inline"` renders it in place.
24
+ * @default "dialog"
25
+ */
26
+ variant?: "dialog" | "inline";
27
+ /** Whether the dialog is open. Ignored when `variant` is `"inline"`. */
28
+ open?: boolean;
29
+ /** Called when the dialog is dismissed, and after the filter is applied. */
30
+ onClose?: () => void;
31
+ /** The filter tree. Use together with `onChange` for a controlled component. */
32
+ value?: FilterTree | null;
33
+ /** The initial filter tree when uncontrolled. */
34
+ defaultValue?: FilterTree | null;
35
+ /** Called on every edit. */
36
+ onChange?: (filter: FilterTree) => void;
37
+ /**
38
+ * Called when the user applies the filter. The tree is pruned, so incomplete
39
+ * conditions are dropped and an empty filter is reported as `null`.
40
+ */
41
+ onApply?: (filter: FilterTree | null, filterString: string) => void;
42
+ /**
43
+ * Applies the filter to a data object when the user confirms. The filter is
44
+ * written to a named slot, so it composes with other filter providers on the
45
+ * same data object instead of overwriting them.
46
+ */
47
+ dataObject?: DataObject<any>;
48
+ /**
49
+ * Parameter the filter is applied to.
50
+ * @default "filterObject"
51
+ */
52
+ filterType?: NamedFilterType;
53
+ /**
54
+ * Name of the slot the filter is applied to.
55
+ * @default "filterBuilder"
56
+ */
57
+ slotName?: string;
58
+ /**
59
+ * Shows the filter string below the tree.
60
+ * @default true
61
+ */
62
+ showFilterString?: boolean;
63
+ /** Called whenever the filter string is reconverted. */
64
+ onFilterStringChange?: (filterString: string) => void;
65
+ /** Called when a saved filter is selected, and with `null` for "New Filter". */
66
+ onSelect?: (filter: SavedFilter | null) => void;
67
+ /**
68
+ * Extra columns written along with the filter when it is saved. The report
69
+ * launcher stores its header text, its hide-criteria flag and its parameter
70
+ * values here.
71
+ */
72
+ saveValues?: SavedFilterValues;
73
+ /**
74
+ * Hides the OK/Cancel row, for callers that supply their own actions. The
75
+ * saved-filter toolbar stays.
76
+ */
77
+ hideActions?: boolean;
78
+ /**
79
+ * Replaces the OK/Cancel buttons, so a caller's own actions share the row
80
+ * with the buttons acting on the selected saved filter.
81
+ */
82
+ actions?: ReactNode;
83
+ /**
84
+ * Wraps the criteria editor, for callers that put it beside content of their
85
+ * own — the report launcher puts it in a tab next to the report parameters.
86
+ * Whatever is returned fills the column next to the saved-filter list.
87
+ */
88
+ renderMain?: (editor: ReactNode) => ReactNode;
89
+ /** Hides the saved-filter list, leaving just the criteria editor. */
90
+ hideSavedFilters?: boolean;
91
+ className?: string;
92
+ "data-size"?: FilterEditorSize;
93
+ };
94
+ /** The parts of a saved filter the builder writes on behalf of a caller. */
95
+ export type SavedFilterValues = Pick<SaveFilterInput, "headerText" | "hideCriteria" | "parameters">;
96
+ /**
97
+ * The web port of the Windows filter builder: the saved-filter list, the
98
+ * criteria editor and the save/share toolbar.
99
+ *
100
+ * Saved filters are stored as criteria strings, so selecting one round-trips
101
+ * through the conversion endpoint to rebuild the tree, and saving converts the
102
+ * tree back.
103
+ *
104
+ * @example
105
+ * ```jsx
106
+ * <FilterBuilder
107
+ * open={open}
108
+ * fields={dsPersons.getFields()}
109
+ * viewName="aviw_Personnel_Persons"
110
+ * dataObject={dsPersons}
111
+ * onClose={() => setOpen(false)}
112
+ * />
113
+ * ```
114
+ */
115
+ export declare function FilterBuilder({ fields, viewName, dbObjectId, reportId, getFieldOptions, variant, open, onClose, value, defaultValue, onChange, onApply, dataObject, filterType, slotName, showFilterString, onFilterStringChange, onSelect, saveValues, hideActions, actions, renderMain, hideSavedFilters, className, "data-size": size, }: FilterBuilderProps): import("react").JSX.Element;
@@ -0,0 +1,146 @@
1
+ import { Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
2
+ import "./FilterBuilder.css";
3
+ import { Button, Checkbox, Dialog, Heading } from "@digdir/designsystemet-react";
4
+ import { XMarkIcon } from "@navikt/aksel-icons";
5
+ import { canEditSavedFilter, canSetCrossDomain, canShareSavedFilter, createEmptyFilter, findSavedFilter, getLocalizedString, isEmptyFilter, pruneFilter, } from "@olenbetong/appframe-core";
6
+ import { setNamedFilter, useFilterConversion, useSavedFilters } from "@olenbetong/appframe-react";
7
+ import clsx from "clsx";
8
+ import { useCallback, useEffect, useState } from "react";
9
+ import { FilterEditor } from "./FilterEditor.js";
10
+ import { FilterNameDialog } from "./FilterNameDialog.js";
11
+ import { FilterShareDialog } from "./FilterShareDialog.js";
12
+ import { SavedFilterTree } from "./SavedFilterTree.js";
13
+ /**
14
+ * The web port of the Windows filter builder: the saved-filter list, the
15
+ * criteria editor and the save/share toolbar.
16
+ *
17
+ * Saved filters are stored as criteria strings, so selecting one round-trips
18
+ * through the conversion endpoint to rebuild the tree, and saving converts the
19
+ * tree back.
20
+ *
21
+ * @example
22
+ * ```jsx
23
+ * <FilterBuilder
24
+ * open={open}
25
+ * fields={dsPersons.getFields()}
26
+ * viewName="aviw_Personnel_Persons"
27
+ * dataObject={dsPersons}
28
+ * onClose={() => setOpen(false)}
29
+ * />
30
+ * ```
31
+ */
32
+ export function FilterBuilder({ fields, viewName, dbObjectId, reportId, getFieldOptions, variant = "dialog", open = true, onClose, value, defaultValue, onChange, onApply, dataObject, filterType = "filterObject", slotName = "filterBuilder", showFilterString = true, onFilterStringChange, onSelect, saveValues, hideActions, actions, renderMain, hideSavedFilters, className, "data-size": size = "sm", }) {
33
+ let resolvedId = dbObjectId ?? viewName;
34
+ let { mine, shared, filters, loading, save, rename, remove, setCrossDomain } = useSavedFilters({
35
+ dbObjectId: reportId ? undefined : resolvedId,
36
+ reportId,
37
+ });
38
+ let [uncontrolled, setUncontrolled] = useState(() => defaultValue ?? createEmptyFilter());
39
+ let isControlled = value !== undefined;
40
+ let filter = isControlled ? (value ?? createEmptyFilter()) : uncontrolled;
41
+ let [selectedId, setSelectedId] = useState(null);
42
+ let [dirty, setDirty] = useState(false);
43
+ let [saving, setSaving] = useState(false);
44
+ let [sharing, setSharing] = useState(false);
45
+ let [error, setError] = useState(null);
46
+ let { filterString, isConverting, parseFilterString } = useFilterConversion(filter, { viewName });
47
+ let selected = findSavedFilter(filters, selectedId);
48
+ useEffect(() => {
49
+ onFilterStringChange?.(filterString);
50
+ }, [filterString, onFilterStringChange]);
51
+ let update = useCallback((next) => {
52
+ if (!isControlled)
53
+ setUncontrolled(next);
54
+ onChange?.(next);
55
+ setDirty(true);
56
+ }, [isControlled, onChange]);
57
+ function applyFilter(next, markClean) {
58
+ if (!isControlled)
59
+ setUncontrolled(next);
60
+ onChange?.(next);
61
+ if (markClean)
62
+ setDirty(false);
63
+ }
64
+ async function handleSelect(filterId) {
65
+ setSelectedId(filterId);
66
+ setError(null);
67
+ if (filterId === null) {
68
+ applyFilter(createEmptyFilter(), true);
69
+ onSelect?.(null);
70
+ return;
71
+ }
72
+ let savedFilter = findSavedFilter(filters, filterId);
73
+ if (!savedFilter)
74
+ return;
75
+ onSelect?.(savedFilter);
76
+ // Filters are stored as criteria strings, so the tree has to be rebuilt.
77
+ let parsed = await parseFilterString(savedFilter.criteria);
78
+ applyFilter(parsed ?? createEmptyFilter(), true);
79
+ }
80
+ async function handleSave(name) {
81
+ setSaving(false);
82
+ setError(null);
83
+ try {
84
+ // Saving under an existing name of the user's own replaces that
85
+ // filter rather than creating a duplicate.
86
+ let existing = mine.find((candidate) => candidate.name === name);
87
+ let saved = await save({
88
+ ...saveValues,
89
+ filterId: existing?.filterId ?? null,
90
+ name,
91
+ criteria: filterString,
92
+ crossDomain: existing?.crossDomain ?? undefined,
93
+ });
94
+ if (saved)
95
+ setSelectedId(saved.filterId);
96
+ setDirty(false);
97
+ }
98
+ catch (cause) {
99
+ setError(String(cause?.message ?? cause));
100
+ }
101
+ }
102
+ async function handleOverwrite() {
103
+ if (!selected)
104
+ return;
105
+ setError(null);
106
+ try {
107
+ await save({ ...saveValues, filterId: selected.filterId, name: selected.name, criteria: filterString });
108
+ setDirty(false);
109
+ }
110
+ catch (cause) {
111
+ setError(String(cause?.message ?? cause));
112
+ }
113
+ }
114
+ function handleRename(savedFilter) {
115
+ let name = globalThis.prompt?.(getLocalizedString("Filter name"), savedFilter.name);
116
+ if (name?.trim())
117
+ void rename(savedFilter.filterId, name.trim());
118
+ }
119
+ function handleDelete(savedFilter) {
120
+ let message = getLocalizedString("Delete the filter {0}?").replace("{0}", savedFilter.name);
121
+ if (!globalThis.confirm?.(message))
122
+ return;
123
+ void remove(savedFilter.filterId).then(() => {
124
+ if (savedFilter.filterId === selectedId)
125
+ void handleSelect(null);
126
+ });
127
+ }
128
+ function handleApply() {
129
+ let pruned = pruneFilter(filter);
130
+ if (dataObject) {
131
+ setNamedFilter(dataObject, slotName, pruned, { type: filterType });
132
+ }
133
+ onApply?.(pruned, filterString);
134
+ onClose?.();
135
+ }
136
+ let isEmpty = isEmptyFilter(filter);
137
+ let canOverwrite = Boolean(selected) && canEditSavedFilter(selected) && dirty && !isEmpty;
138
+ let editor = (_jsx(FilterEditor, { fields: fields, value: filter, viewName: viewName, getFieldOptions: getFieldOptions, showFilterString: showFilterString, "data-size": size, onChange: update }));
139
+ let content = (_jsxs("div", { className: clsx("ObFilterBuilder-root", hideSavedFilters && "ObFilterBuilder-root--noSavedFilters", className), "data-size": size, children: [!hideSavedFilters && (_jsx("div", { className: "ObFilterBuilder-sidebar", children: _jsx(SavedFilterTree, { mine: mine, shared: shared, value: selectedId, dirty: dirty, loading: loading, "data-size": size, onChange: (filterId) => void handleSelect(filterId), onRename: handleRename, onDelete: handleDelete }) })), _jsx("div", { className: "ObFilterBuilder-main", children: renderMain ? renderMain(editor) : editor }), error && (_jsx("p", { className: "ObFilterBuilder-error", role: "alert", children: error })), _jsxs("div", { className: "ObFilterBuilder-footer", children: [!hideSavedFilters && (_jsxs("div", { className: "ObFilterBuilder-toolbar", children: [_jsx(Button, { type: "button", variant: "secondary", "data-size": size, disabled: !selected || !canShareSavedFilter(selected), onClick: () => setSharing(true), children: getLocalizedString("Sharing...") }), _jsx(Button, { type: "button", variant: "secondary", "data-size": size, disabled: isEmpty || isConverting, onClick: () => setSaving(true), children: getLocalizedString("Save as") }), _jsx(Button, { type: "button", variant: "secondary", "data-size": size, disabled: !canOverwrite || isConverting, onClick: () => void handleOverwrite(), children: getLocalizedString("Save") }), _jsx(Checkbox, { "data-size": size, label: getLocalizedString("All Domains"), checked: selected?.crossDomain ?? false, disabled: !selected || !canSetCrossDomain(selected), onChange: (event) => {
140
+ if (selected)
141
+ void setCrossDomain(selected.filterId, event.currentTarget.checked);
142
+ } })] })), !hideActions && (_jsx("div", { className: "ObFilterBuilder-actions", children: actions ?? (_jsxs(_Fragment, { children: [_jsx(Button, { type: "button", "data-size": size, onClick: handleApply, children: getLocalizedString("OK") }), _jsx(Button, { type: "button", variant: "secondary", "data-size": size, onClick: onClose, children: getLocalizedString("Cancel") })] })) }))] }), _jsx(FilterNameDialog, { open: saving, defaultName: selected?.name ?? "", existingNames: mine.map((candidate) => candidate.name), "data-size": size, onCancel: () => setSaving(false), onSubmit: (name) => void handleSave(name) }), _jsx(FilterShareDialog, { open: sharing, filterId: selectedId, filterName: selected?.name, "data-size": size, onClose: () => setSharing(false) })] }));
143
+ if (variant === "inline")
144
+ return content;
145
+ return (_jsxs(Dialog, { open: open, closedby: "closerequest", closeButton: false, "data-size": size, className: "ObFilterBuilder-dialog", onClose: onClose, children: [_jsxs(Dialog.Block, { className: "ObFilterBuilder-dialogHeader", children: [_jsx(Heading, { level: 2, "data-size": "xs", children: getLocalizedString("Edit filter") }), _jsx(Button, { type: "button", variant: "tertiary", "data-color": "neutral", "data-size": size, icon: true, "aria-label": getLocalizedString("Close"), onClick: onClose, children: _jsx(XMarkIcon, { "aria-hidden": true }) })] }), _jsx(Dialog.Block, { className: "ObFilterBuilder-dialogBody", children: content })] }));
146
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,120 @@
1
+ import { jsx as _jsx } from "react/jsx-runtime";
2
+ import { render, screen, waitFor } from "@testing-library/react";
3
+ import userEvent from "@testing-library/user-event";
4
+ import { beforeEach, describe, expect, it, vi } from "vitest";
5
+ const save = vi.fn(async () => undefined);
6
+ const remove = vi.fn(async () => undefined);
7
+ const rename = vi.fn(async () => undefined);
8
+ const setCrossDomain = vi.fn(async () => undefined);
9
+ const setNamedFilter = vi.fn();
10
+ const parseFilterString = vi.fn(async () => null);
11
+ let savedFilters = [];
12
+ vi.mock("@olenbetong/appframe-react", async (importOriginal) => ({
13
+ ...(await importOriginal()),
14
+ setNamedFilter: (...args) => setNamedFilter(...args),
15
+ useSavedFilters: () => ({
16
+ filters: savedFilters,
17
+ mine: savedFilters.filter((filter) => filter.createdByUser),
18
+ shared: savedFilters.filter((filter) => !filter.createdByUser),
19
+ loading: false,
20
+ error: null,
21
+ refresh: vi.fn(),
22
+ save,
23
+ rename,
24
+ remove,
25
+ setCrossDomain,
26
+ }),
27
+ useFilterConversion: () => ({
28
+ filterString: "[PersonID] Like '%a%'",
29
+ isConverting: false,
30
+ error: null,
31
+ parseFilterString,
32
+ }),
33
+ }));
34
+ const { FilterBuilder } = await import("./FilterBuilder.js");
35
+ const FIELDS = [
36
+ { name: "PersonID", caption: "Person ID", type: "string", nullable: true },
37
+ { name: "Age", caption: "Age", type: "number" },
38
+ ];
39
+ function savedFilter(overrides) {
40
+ return {
41
+ primKey: `pk-${overrides.filterId}`,
42
+ criteria: "[PersonID] Like '%a%'",
43
+ dbObjectId: "aviw_Test_View",
44
+ accessLevel: "Manager",
45
+ createdByUser: true,
46
+ createdBy: "bvh",
47
+ domain: "OB",
48
+ crossDomain: false,
49
+ isPersonallyShared: false,
50
+ hideCriteria: false,
51
+ headerText: null,
52
+ comment: null,
53
+ parameters: null,
54
+ reportTitle: null,
55
+ created: null,
56
+ updated: null,
57
+ ...overrides,
58
+ };
59
+ }
60
+ function renderBuilder(props = {}) {
61
+ return render(_jsx(FilterBuilder, { fields: FIELDS, viewName: "aviw_Test_View", variant: "inline", ...props }));
62
+ }
63
+ describe("FilterBuilder", () => {
64
+ beforeEach(() => {
65
+ vi.clearAllMocks();
66
+ savedFilters = [savedFilter({ filterId: 1, name: "Agder" })];
67
+ });
68
+ it("renders the saved filters beside the editor", () => {
69
+ renderBuilder();
70
+ expect(screen.getByRole("button", { name: "New Filter" })).toBeTruthy();
71
+ expect(screen.getByRole("button", { name: "Agder" })).toBeTruthy();
72
+ expect(screen.getByLabelText("Add condition")).toBeTruthy();
73
+ });
74
+ it("disables save and share until a filter is selected", () => {
75
+ renderBuilder();
76
+ expect(screen.getByRole("button", { name: "Sharing..." }).hasAttribute("disabled")).toBe(true);
77
+ expect(screen.getByRole("button", { name: "Save" }).hasAttribute("disabled")).toBe(true);
78
+ });
79
+ it("disables save as while the filter is empty", () => {
80
+ renderBuilder();
81
+ expect(screen.getByRole("button", { name: "Save as" }).hasAttribute("disabled")).toBe(true);
82
+ });
83
+ it("parses the criteria of a selected filter back into the tree", async () => {
84
+ renderBuilder();
85
+ await userEvent.click(screen.getByRole("button", { name: "Agder" }));
86
+ expect(parseFilterString).toHaveBeenCalledWith("[PersonID] Like '%a%'");
87
+ });
88
+ it("applies the pruned filter to the data object", async () => {
89
+ let dataObject = {};
90
+ renderBuilder({
91
+ dataObject,
92
+ defaultValue: {
93
+ type: "group",
94
+ mode: "and",
95
+ items: [{ type: "expression", column: "PersonID", operator: "like", value: "a", valueType: "string" }],
96
+ },
97
+ });
98
+ await userEvent.click(screen.getByRole("button", { name: "OK" }));
99
+ expect(setNamedFilter).toHaveBeenCalledWith(dataObject, "filterBuilder", expect.objectContaining({ type: "group" }), { type: "filterObject" });
100
+ });
101
+ it("reports an empty filter as null", async () => {
102
+ let onApply = vi.fn();
103
+ renderBuilder({ onApply });
104
+ await userEvent.click(screen.getByRole("button", { name: "OK" }));
105
+ expect(onApply).toHaveBeenCalledWith(null, "[PersonID] Like '%a%'");
106
+ });
107
+ it("saves under a new name and replaces a filter that already uses it", async () => {
108
+ renderBuilder({
109
+ defaultValue: {
110
+ type: "group",
111
+ mode: "and",
112
+ items: [{ type: "expression", column: "PersonID", operator: "like", value: "a", valueType: "string" }],
113
+ },
114
+ });
115
+ await userEvent.click(screen.getByRole("button", { name: "Save as" }));
116
+ await userEvent.type(screen.getByRole("textbox", { name: "Filter name" }), "Agder");
117
+ await userEvent.click(screen.getByRole("button", { name: "Replace" }));
118
+ await waitFor(() => expect(save).toHaveBeenCalledWith(expect.objectContaining({ filterId: 1, name: "Agder", criteria: "[PersonID] Like '%a%'" })));
119
+ });
120
+ });