@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
@@ -0,0 +1,421 @@
1
+ import "./ReportLauncher.css";
2
+
3
+ import { Button, Checkbox, Dialog, Dropdown, Heading, Tabs, Textfield } from "@digdir/designsystemet-react";
4
+ import { ChevronDownIcon, XMarkIcon } from "@navikt/aksel-icons";
5
+ import {
6
+ convertFilter,
7
+ createEmptyFilter,
8
+ type FieldMetadata,
9
+ type FilterTree,
10
+ getLocalizedString,
11
+ type ReportFormat,
12
+ type ReportParameterValues,
13
+ restoreParameterValues,
14
+ type SavedFilter,
15
+ serializeParameters,
16
+ } from "@olenbetong/appframe-core";
17
+ import { useFilterFields, useReport, useReportRender } from "@olenbetong/appframe-react";
18
+ import clsx from "clsx";
19
+ import { useEffect, useId, useMemo, useState } from "react";
20
+
21
+ import { FilterBuilder } from "../filter/FilterBuilder.js";
22
+ import type { FilterEditorSize, GetFieldOptions } from "../filter/types.js";
23
+ import { ReportParameters } from "./ReportParameters.js";
24
+
25
+ /** The label shown on the save button for each format. */
26
+ const FORMAT_LABELS: Record<ReportFormat, string> = {
27
+ CSV: "Save as CSV",
28
+ HTML: "Save as HTML",
29
+ IMAGE: "Save as image",
30
+ MHT: "Save as MHT",
31
+ PDF: "Save as PDF",
32
+ RTF: "Save as RTF",
33
+ TEXT: "Save as text",
34
+ XLS: "Save as XLS (Excel)",
35
+ XLSX: "Save as XLSX (Excel 2007)",
36
+ };
37
+
38
+ export type ReportLauncherTab = "parameters" | "filter";
39
+
40
+ export type ReportLauncherProps = {
41
+ /** The report to run, e.g. `arpt_Personnel_Persons`. */
42
+ reportId: string;
43
+ /**
44
+ * `"dialog"` wraps the launcher 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 launcher is dismissed. */
51
+ onClose?: () => void;
52
+ /**
53
+ * Overrides the filter the report was designed with, as a criteria string.
54
+ * An empty string starts the launcher with no filter at all.
55
+ */
56
+ initialFilter?: string | null;
57
+ /**
58
+ * The fields the filter can be built from. Loaded from the report's view
59
+ * when not supplied.
60
+ */
61
+ fields?: FieldMetadata[];
62
+ /**
63
+ * The tab shown first.
64
+ * @default "parameters"
65
+ */
66
+ defaultTab?: ReportLauncherTab;
67
+ getFieldOptions?: GetFieldOptions;
68
+ className?: string;
69
+ "data-size"?: FilterEditorSize;
70
+ };
71
+
72
+ /**
73
+ * The web port of the Windows report launcher: the saved filters and criteria
74
+ * editor of the filter builder, the report's parameters, the report options,
75
+ * and the save/preview/print actions.
76
+ *
77
+ * Everything the launcher needs comes from the report itself, so a caller only
78
+ * has to name it. A report that does not resolve is one the current user has no
79
+ * access to — `sviw_WinClient_MyReports` is permission-resolved.
80
+ *
81
+ * @example
82
+ * ```jsx
83
+ * <ReportLauncher
84
+ * reportId="arpt_Production_ElementsDaily"
85
+ * open={open}
86
+ * initialFilter={`[ProjectID] = '${projectId}'`}
87
+ * onClose={() => setOpen(false)}
88
+ * />
89
+ * ```
90
+ */
91
+ export function ReportLauncher({
92
+ reportId,
93
+ variant = "dialog",
94
+ open = true,
95
+ onClose,
96
+ initialFilter: initialFilterOverride,
97
+ fields: fieldsOverride,
98
+ defaultTab = "parameters",
99
+ getFieldOptions,
100
+ className,
101
+ "data-size": size = "sm",
102
+ }: ReportLauncherProps) {
103
+ let { report, parameters, initialFilter, defaultValues, loading, error } = useReport(reportId, {
104
+ initialFilter: initialFilterOverride,
105
+ });
106
+ let viewName = report?.viewName ?? undefined;
107
+ let { fields: loadedFields } = useFilterFields(fieldsOverride ? null : viewName);
108
+ let fields = fieldsOverride ?? loadedFields;
109
+ let { open: openReport, print, download, isRendering, progress, error: renderError } = useReportRender(reportId);
110
+
111
+ let [filter, setFilter] = useState<FilterTree>(createEmptyFilter);
112
+ let [filterString, setFilterString] = useState("");
113
+ let [values, setValues] = useState<ReportParameterValues>({});
114
+ let [reportTitle, setReportTitle] = useState("");
115
+ let [headerText, setHeaderText] = useState("");
116
+ let [hideFilterString, setHideFilterString] = useState(false);
117
+ let [tab, setTab] = useState<ReportLauncherTab>(defaultTab);
118
+ let panelId = useId();
119
+
120
+ // The report's own defaults arrive in two rounds — the literal ones first,
121
+ // then the ones a stored procedure produces — so they are copied into the
122
+ // form whenever they change rather than only once.
123
+ useEffect(() => {
124
+ setValues(defaultValues);
125
+ }, [defaultValues]);
126
+
127
+ useEffect(() => {
128
+ setReportTitle(report?.title ?? "");
129
+ }, [report?.title]);
130
+
131
+ /*
132
+ * The initial filter is a criteria string, so it has to be parsed into a
133
+ * tree before the editor can show it.
134
+ */
135
+ useEffect(() => {
136
+ if (!initialFilter) {
137
+ setFilter(createEmptyFilter());
138
+
139
+ return;
140
+ }
141
+
142
+ let controller = new AbortController();
143
+
144
+ convertFilter({ filterString: initialFilter, viewName }, controller.signal)
145
+ .then((result) => {
146
+ if (!controller.signal.aborted) setFilter(result.filterObject ?? createEmptyFilter());
147
+ })
148
+ .catch(() => {
149
+ // An initial filter the converter rejects is better dropped than
150
+ // blocking the launcher; the user can rebuild it.
151
+ });
152
+
153
+ return () => {
154
+ controller.abort();
155
+ };
156
+ }, [initialFilter, viewName]);
157
+
158
+ /** Selecting a saved filter restores the report options stored with it. */
159
+ function handleSelectFilter(saved: SavedFilter | null) {
160
+ if (!saved) {
161
+ setValues(defaultValues);
162
+ setHeaderText("");
163
+ setHideFilterString(false);
164
+ setReportTitle(report?.title ?? "");
165
+
166
+ return;
167
+ }
168
+
169
+ setValues(restoreParameterValues(parameters, saved.parameters));
170
+ setHeaderText(saved.headerText ?? "");
171
+ setHideFilterString(saved.hideCriteria);
172
+ setReportTitle(saved.reportTitle ?? report?.title ?? "");
173
+ }
174
+
175
+ let saveValues = useMemo(
176
+ () => ({
177
+ headerText: headerText || null,
178
+ hideCriteria: hideFilterString,
179
+ parameters: parameters.length > 0 ? serializeParameters(parameters, values) : null,
180
+ }),
181
+ [headerText, hideFilterString, parameters, values],
182
+ );
183
+
184
+ let formats = report?.formats ?? [];
185
+ // PDF is the only format worth previewing or printing in place; the rest are
186
+ // downloads whatever the browser is asked to do with them.
187
+ let canPreview = formats.includes("PDF");
188
+
189
+ function getRenderOptions(format: ReportFormat) {
190
+ return {
191
+ format,
192
+ fileName: reportTitle || report?.title || reportId,
193
+ filter: filterString,
194
+ parameters: values,
195
+ headerText: report?.hasHeader ? headerText : null,
196
+ hideFilterString,
197
+ };
198
+ }
199
+
200
+ function run(action: (options: ReturnType<typeof getRenderOptions>) => Promise<void>, format: ReportFormat) {
201
+ void action(getRenderOptions(format));
202
+ }
203
+
204
+ /*
205
+ * The parameters and the criteria are too much to show at once, so they get
206
+ * a tab each. The report options stay below the tabs: they apply to the
207
+ * report whichever tab is open, and the hide-criteria flag in particular
208
+ * reads as belonging to both.
209
+ */
210
+ let options = (
211
+ <div className="ObReportLauncher-options">
212
+ {report?.hasTitle && (
213
+ <Textfield
214
+ data-size={size}
215
+ label={getLocalizedString("Report name")}
216
+ description={getLocalizedString("Used as the file name when the report is saved.")}
217
+ value={reportTitle}
218
+ onChange={(event) => setReportTitle(event.target.value)}
219
+ />
220
+ )}
221
+ {report?.hasHeader && (
222
+ <Textfield
223
+ data-size={size}
224
+ multiline
225
+ rows={2}
226
+ label={getLocalizedString("Optional text (at the top of every page)")}
227
+ value={headerText}
228
+ onChange={(event) => setHeaderText(event.target.value)}
229
+ />
230
+ )}
231
+ <Checkbox
232
+ data-size={size}
233
+ label={getLocalizedString("Do not show the filter criteria at the top of the pages")}
234
+ checked={hideFilterString}
235
+ onChange={(event) => setHideFilterString(event.currentTarget.checked)}
236
+ />
237
+ </div>
238
+ );
239
+
240
+ let actions = (
241
+ <div className="ObReportLauncher-actions">
242
+ {isRendering && (
243
+ <span className="ObReportLauncher-progress">
244
+ {progress?.bytesReceived
245
+ ? `${Math.round(progress.bytesReceived / 1024)} kB`
246
+ : getLocalizedString("Rendering...")}
247
+ </span>
248
+ )}
249
+ {formats.length > 0 && (
250
+ <div className="ObReportLauncher-saveGroup">
251
+ <Button type="button" data-size={size} disabled={isRendering} onClick={() => run(download, formats[0])}>
252
+ {getLocalizedString(FORMAT_LABELS[formats[0]])}
253
+ </Button>
254
+ {formats.length > 1 && (
255
+ <Dropdown.TriggerContext>
256
+ <Dropdown.Trigger
257
+ data-size={size}
258
+ icon
259
+ disabled={isRendering}
260
+ aria-label={getLocalizedString("More formats")}
261
+ >
262
+ <ChevronDownIcon aria-hidden />
263
+ </Dropdown.Trigger>
264
+ <Dropdown>
265
+ <Dropdown.List>
266
+ {formats.slice(1).map((format) => (
267
+ <Dropdown.Item key={format}>
268
+ <Dropdown.Button onClick={() => run(download, format)}>
269
+ {getLocalizedString(FORMAT_LABELS[format])}
270
+ </Dropdown.Button>
271
+ </Dropdown.Item>
272
+ ))}
273
+ </Dropdown.List>
274
+ </Dropdown>
275
+ </Dropdown.TriggerContext>
276
+ )}
277
+ </div>
278
+ )}
279
+ <Button
280
+ type="button"
281
+ variant="secondary"
282
+ data-size={size}
283
+ disabled={!canPreview || isRendering}
284
+ onClick={() => run(openReport, "PDF")}
285
+ >
286
+ {getLocalizedString("Preview")}
287
+ </Button>
288
+ <Button
289
+ type="button"
290
+ variant="secondary"
291
+ data-size={size}
292
+ disabled={!canPreview || isRendering}
293
+ onClick={() => run(print, "PDF")}
294
+ >
295
+ {getLocalizedString("Print")}
296
+ </Button>
297
+ <Button type="button" variant="tertiary" data-size={size} onClick={onClose}>
298
+ {getLocalizedString("Close")}
299
+ </Button>
300
+ </div>
301
+ );
302
+
303
+ let content = (
304
+ <div className={clsx("ObReportLauncher-root", className)} data-size={size}>
305
+ {loading && <p className="ObReportLauncher-status">{getLocalizedString("Loading...")}</p>}
306
+ {!loading && !report && (
307
+ <p className="ObReportLauncher-error" role="alert">
308
+ {error
309
+ ? error.message
310
+ : getLocalizedString("The report does not exist, or you do not have access to run it.")}
311
+ </p>
312
+ )}
313
+ {report && (
314
+ <FilterBuilder
315
+ fields={fields}
316
+ viewName={viewName}
317
+ reportId={reportId}
318
+ getFieldOptions={getFieldOptions}
319
+ variant="inline"
320
+ value={filter}
321
+ data-size={size}
322
+ actions={actions}
323
+ saveValues={saveValues}
324
+ onChange={setFilter}
325
+ onFilterStringChange={setFilterString}
326
+ onSelect={handleSelectFilter}
327
+ renderMain={(editor) => (
328
+ <div className="ObReportLauncher-main">
329
+ <Tabs
330
+ value={tab}
331
+ data-size={size}
332
+ className="ObReportLauncher-tabs"
333
+ onChange={(value) => setTab(value as ReportLauncherTab)}
334
+ >
335
+ <Tabs.List>
336
+ <Tabs.Tab value="parameters" aria-controls={`${panelId}-parameters`}>
337
+ {parameters.length > 0 ? getLocalizedString("Parameters") : getLocalizedString("Report")}
338
+ </Tabs.Tab>
339
+ <Tabs.Tab value="filter" aria-controls={`${panelId}-filter`}>
340
+ {getLocalizedString("Filter")}
341
+ </Tabs.Tab>
342
+ </Tabs.List>
343
+ </Tabs>
344
+ {/*
345
+ * The panels are rendered outside `Tabs` rather than as
346
+ * `Tabs.Panel`, so the criteria editor gets a flex parent
347
+ * it can fill and scroll inside of.
348
+ */}
349
+ {tab === "parameters" ? (
350
+ <div
351
+ role="tabpanel"
352
+ id={`${panelId}-parameters`}
353
+ className="ObReportLauncher-panel ObReportLauncher-panel--scroll"
354
+ >
355
+ {parameters.length > 0 ? (
356
+ // No legend: the tab is labelled "Parameters" already.
357
+ <ReportParameters
358
+ parameters={parameters}
359
+ values={values}
360
+ onChange={setValues}
361
+ legend={null}
362
+ data-size={size}
363
+ />
364
+ ) : (
365
+ <p className="ObReportLauncher-status">{getLocalizedString("The report has no parameters.")}</p>
366
+ )}
367
+ </div>
368
+ ) : (
369
+ <div role="tabpanel" id={`${panelId}-filter`} className="ObReportLauncher-panel">
370
+ {editor}
371
+ </div>
372
+ )}
373
+ {options}
374
+ </div>
375
+ )}
376
+ />
377
+ )}
378
+ {renderError && (
379
+ <p className="ObReportLauncher-error" role="alert">
380
+ {renderError.message}
381
+ </p>
382
+ )}
383
+ </div>
384
+ );
385
+
386
+ if (variant === "inline") return content;
387
+
388
+ return (
389
+ <Dialog
390
+ open={open}
391
+ closedby="closerequest"
392
+ closeButton={false}
393
+ data-size={size}
394
+ className="ObReportLauncher-dialog"
395
+ onClose={onClose}
396
+ >
397
+ {/* As in the filter builder, `Dialog`'s floated close button does not
398
+ survive a flex layout, so the header renders its own. */}
399
+ <Dialog.Block className="ObReportLauncher-dialogHeader">
400
+ <Heading level={2} data-size="xs">
401
+ {getLocalizedString("Report")}: {report?.title ?? reportId}
402
+ {/* The report number is what users refer to a report by — it is
403
+ printed in the footer of every report. */}
404
+ {report?.shortId !== null && report?.shortId !== undefined && ` (ID: ${report.shortId})`}
405
+ </Heading>
406
+ <Button
407
+ type="button"
408
+ variant="tertiary"
409
+ data-color="neutral"
410
+ data-size={size}
411
+ icon
412
+ aria-label={getLocalizedString("Close")}
413
+ onClick={onClose}
414
+ >
415
+ <XMarkIcon aria-hidden />
416
+ </Button>
417
+ </Dialog.Block>
418
+ <Dialog.Block className="ObReportLauncher-dialogBody">{content}</Dialog.Block>
419
+ </Dialog>
420
+ );
421
+ }
@@ -0,0 +1,29 @@
1
+ .ObReportParameters-root {
2
+ margin: 0;
3
+ padding: 0;
4
+ border: none;
5
+ min-inline-size: 0;
6
+ }
7
+
8
+ .ObReportParameters-legend {
9
+ padding: 0;
10
+ margin-block-end: var(--ds-size-2);
11
+ font-size: var(--ds-font-size-3);
12
+ font-weight: var(--ds-font-weight-medium);
13
+ }
14
+
15
+ /*
16
+ * The parameters are stacked rather than laid out in columns: a report has a
17
+ * handful at most, and a single column keeps them readable next to the report
18
+ * options below them.
19
+ */
20
+ .ObReportParameters-grid {
21
+ display: flex;
22
+ flex-direction: column;
23
+ gap: var(--ds-size-3);
24
+ align-items: stretch;
25
+ }
26
+
27
+ .ObReportParameters-field {
28
+ min-inline-size: 0;
29
+ }
@@ -0,0 +1,133 @@
1
+ import type { ReportParameter } from "@olenbetong/appframe-core";
2
+ import { render, screen } from "@testing-library/react";
3
+ import userEvent from "@testing-library/user-event";
4
+ import { describe, expect, it, vi } from "vitest";
5
+
6
+ let parameterOptions: { value: string; label: string }[] = [];
7
+
8
+ vi.mock("@olenbetong/appframe-react", async (importOriginal) => ({
9
+ ...(await importOriginal<Record<string, unknown>>()),
10
+ useParameterOptions: () => ({ options: parameterOptions, loading: false, error: null }),
11
+ }));
12
+
13
+ const { ReportParameters } = await import("./ReportParameters.js");
14
+
15
+ function parameter(overrides: Partial<ReportParameter> & Pick<ReportParameter, "name">): ReportParameter {
16
+ return {
17
+ label: overrides.name,
18
+ description: null,
19
+ type: "String",
20
+ editor: "text",
21
+ defaultValue: null,
22
+ items: [],
23
+ recordSource: null,
24
+ valueMember: null,
25
+ displayMember: null,
26
+ sortOrder: 0,
27
+ lookupWidth: null,
28
+ lookupHeight: null,
29
+ ...overrides,
30
+ };
31
+ }
32
+
33
+ describe("ReportParameters", () => {
34
+ it("renders nothing when the report has no parameters", () => {
35
+ let { container } = render(<ReportParameters parameters={[]} values={{}} onChange={vi.fn()} />);
36
+
37
+ expect(container).toBeEmptyDOMElement();
38
+ });
39
+
40
+ it("renders a labelled editor per parameter with the description as help text", () => {
41
+ render(
42
+ <ReportParameters
43
+ parameters={[
44
+ parameter({ name: "Period", label: "Periode", type: "Integer", editor: "number" }),
45
+ parameter({ name: "Comment", label: "Kommentar", description: "Vises på forsiden" }),
46
+ ]}
47
+ values={{ Period: 202601, Comment: "" }}
48
+ onChange={vi.fn()}
49
+ />,
50
+ );
51
+
52
+ expect(screen.getByLabelText("Periode")).toHaveValue(202601);
53
+ expect(screen.getByLabelText("Kommentar")).toBeInTheDocument();
54
+ expect(screen.getByText("Vises på forsiden")).toBeInTheDocument();
55
+ });
56
+
57
+ it("coerces numeric input to a number", async () => {
58
+ let onChange = vi.fn();
59
+ let user = userEvent.setup();
60
+ render(
61
+ <ReportParameters
62
+ parameters={[parameter({ name: "Period", type: "Integer", editor: "number" })]}
63
+ values={{ Period: null }}
64
+ onChange={onChange}
65
+ />,
66
+ );
67
+
68
+ await user.type(screen.getByLabelText("Period"), "7");
69
+
70
+ expect(onChange).toHaveBeenCalledWith({ Period: 7 });
71
+ });
72
+
73
+ it("renders a checkbox for boolean parameters", async () => {
74
+ let onChange = vi.fn();
75
+ let user = userEvent.setup();
76
+ render(
77
+ <ReportParameters
78
+ parameters={[parameter({ name: "IncludeClosed", type: "Boolean", editor: "boolean" })]}
79
+ values={{ IncludeClosed: false }}
80
+ onChange={onChange}
81
+ />,
82
+ );
83
+
84
+ await user.click(screen.getByLabelText("IncludeClosed"));
85
+
86
+ expect(onChange).toHaveBeenCalledWith({ IncludeClosed: true });
87
+ });
88
+
89
+ it("renders a select for parameters with a fixed item list", async () => {
90
+ let onChange = vi.fn();
91
+ let user = userEvent.setup();
92
+ render(
93
+ <ReportParameters
94
+ parameters={[parameter({ name: "Type", editor: "select", items: ["Alle", "Åpne"] })]}
95
+ values={{ Type: "Alle" }}
96
+ onChange={onChange}
97
+ />,
98
+ );
99
+
100
+ await user.selectOptions(screen.getByLabelText("Type"), "Åpne");
101
+
102
+ expect(onChange).toHaveBeenCalledWith({ Type: "Åpne" });
103
+ });
104
+
105
+ it("renders lookup options from the record source", () => {
106
+ parameterOptions = [
107
+ { value: "1", label: "1 - Første" },
108
+ { value: "2", label: "2 - Andre" },
109
+ ];
110
+ render(
111
+ <ReportParameters
112
+ parameters={[
113
+ parameter({
114
+ name: "Type",
115
+ editor: "lookup",
116
+ valueMember: "ID",
117
+ recordSource: {
118
+ viewName: "aviw_Test_Types",
119
+ columns: [{ name: "ID", type: "number" }],
120
+ whereClause: null,
121
+ filterString: null,
122
+ maxRecords: null,
123
+ },
124
+ }),
125
+ ]}
126
+ values={{ Type: "2" }}
127
+ onChange={vi.fn()}
128
+ />,
129
+ );
130
+
131
+ expect(screen.getByLabelText("Type")).toHaveValue("2 - Andre");
132
+ });
133
+ });