@olenbetong/synergi-react 2.9.0 → 3.1.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 (62) 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/index.d.ts +8 -0
  18. package/es/filter/index.js +8 -0
  19. package/es/index.d.ts +2 -1
  20. package/es/index.js +6 -1
  21. package/es/mui/MuiThemeProvider.d.ts +24 -0
  22. package/es/mui/MuiThemeProvider.js +152 -0
  23. package/es/mui/index.d.ts +1 -0
  24. package/es/mui/index.js +1 -0
  25. package/es/report/ReportLauncher.css +147 -0
  26. package/es/report/ReportLauncher.d.ts +55 -0
  27. package/es/report/ReportLauncher.js +142 -0
  28. package/es/report/ReportLauncher.test.d.ts +1 -0
  29. package/es/report/ReportLauncher.test.js +231 -0
  30. package/es/report/ReportParameters.css +29 -0
  31. package/es/report/ReportParameters.d.ts +46 -0
  32. package/es/report/ReportParameters.js +65 -0
  33. package/es/report/ReportParameters.test.d.ts +1 -0
  34. package/es/report/ReportParameters.test.js +84 -0
  35. package/es/report/index.d.ts +2 -0
  36. package/es/report/index.js +2 -0
  37. package/es/test/setup.d.ts +1 -0
  38. package/es/test/setup.js +6 -0
  39. package/package.json +22 -7
  40. package/src/chrome/AppShell/index.tsx +34 -171
  41. package/src/components/ImageEditor/ImageEditor.css +15 -5
  42. package/src/components/ImageEditor/ImageEditor.tsx +1 -1
  43. package/src/components/ImageEditor/index.ts +1 -0
  44. package/src/components/ImageEditor/plugins/cropPlugin/CropOverlay.tsx +66 -20
  45. package/src/components/ImageEditor/plugins/cropPlugin/CropToolbar.tsx +19 -3
  46. package/src/components/ImageEditor/plugins/cropPlugin/useCropTool.ts +266 -39
  47. package/src/components/ImageEditor/plugins/zoomPlugin/ZoomContext.tsx +8 -0
  48. package/src/components/ImageEditor/useEdgeDetection.ts +11 -51
  49. package/src/components/ImageEditor/useOpenCV.ts +112 -62
  50. package/src/components/SplitContainer/index.tsx +3 -4
  51. package/src/filter/index.ts +34 -0
  52. package/src/index.ts +39 -1
  53. package/src/mui/MuiThemeProvider.tsx +174 -0
  54. package/src/mui/index.ts +1 -0
  55. package/src/report/ReportLauncher.css +147 -0
  56. package/src/report/ReportLauncher.test.tsx +281 -0
  57. package/src/report/ReportLauncher.tsx +420 -0
  58. package/src/report/ReportParameters.css +29 -0
  59. package/src/report/ReportParameters.test.tsx +133 -0
  60. package/src/report/ReportParameters.tsx +198 -0
  61. package/src/report/index.ts +2 -0
  62. package/src/test/setup.ts +8 -0
@@ -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
+ });
@@ -0,0 +1,198 @@
1
+ import "./ReportParameters.css";
2
+
3
+ import { Checkbox, Field, FieldDescription, Label, Select, Textfield } from "@digdir/designsystemet-react";
4
+ import {
5
+ coerceParameterValue,
6
+ getLocalizedString,
7
+ type ReportParameter,
8
+ type ReportParameterValue,
9
+ type ReportParameterValues,
10
+ } from "@olenbetong/appframe-core";
11
+ import { useParameterOptions } from "@olenbetong/appframe-react";
12
+ import { Combobox } from "@olenbetong/appframe-ds";
13
+ import clsx from "clsx";
14
+ import { useId } from "react";
15
+
16
+ import type { FilterEditorSize } from "@olenbetong/appframe-ds";
17
+
18
+ export type ReportParametersProps = {
19
+ /** The report's parameters, from `useReport`. */
20
+ parameters: ReportParameter[];
21
+ /** Current values, by parameter name. */
22
+ values: ReportParameterValues;
23
+ onChange: (values: ReportParameterValues) => void;
24
+ readOnly?: boolean;
25
+ /** Heading above the parameters. Pass `null` to render none. */
26
+ legend?: string | null;
27
+ className?: string;
28
+ "data-size"?: FilterEditorSize;
29
+ };
30
+
31
+ /**
32
+ * The parameter form of the report launcher.
33
+ *
34
+ * Reports rarely have parameters, so this renders nothing at all when the list
35
+ * is empty and the launcher can include it unconditionally.
36
+ *
37
+ * Each parameter gets the editor its metadata asks for: a lookup combobox when
38
+ * it is backed by a record source, a select when it has a fixed item list, and
39
+ * otherwise an editor for its data type. Values are coerced to the parameter's
40
+ * type as they are entered, so what the caller holds is what gets sent to the
41
+ * report.
42
+ *
43
+ * @example
44
+ * ```jsx
45
+ * let { parameters, defaultValues } = useReport(reportId);
46
+ * let [values, setValues] = useState(defaultValues);
47
+ *
48
+ * <ReportParameters parameters={parameters} values={values} onChange={setValues} />
49
+ * ```
50
+ */
51
+ export function ReportParameters({
52
+ parameters,
53
+ values,
54
+ onChange,
55
+ readOnly,
56
+ legend = getLocalizedString("Parameters"),
57
+ className,
58
+ "data-size": size = "sm",
59
+ }: ReportParametersProps) {
60
+ if (parameters.length === 0) return null;
61
+
62
+ function update(parameter: ReportParameter, value: ReportParameterValue) {
63
+ onChange({ ...values, [parameter.name]: value });
64
+ }
65
+
66
+ return (
67
+ <fieldset className={clsx("ObReportParameters-root", className)} data-size={size}>
68
+ {legend && <legend className="ObReportParameters-legend">{legend}</legend>}
69
+ <div className="ObReportParameters-grid">
70
+ {parameters.map((parameter) => (
71
+ <ReportParameterField
72
+ key={parameter.name}
73
+ parameter={parameter}
74
+ value={values[parameter.name] ?? null}
75
+ onChange={(value) => update(parameter, value)}
76
+ readOnly={readOnly}
77
+ size={size}
78
+ />
79
+ ))}
80
+ </div>
81
+ </fieldset>
82
+ );
83
+ }
84
+
85
+ type ReportParameterFieldProps = {
86
+ parameter: ReportParameter;
87
+ value: ReportParameterValue;
88
+ onChange: (value: ReportParameterValue) => void;
89
+ readOnly?: boolean;
90
+ size: FilterEditorSize;
91
+ };
92
+
93
+ /** The editor for a single parameter. */
94
+ export function ReportParameterField({ parameter, value, onChange, readOnly, size }: ReportParameterFieldProps) {
95
+ // The hook returns nothing for parameters that are not lookups, so it can be
96
+ // called for every parameter.
97
+ let { options, loading } = useParameterOptions(parameter);
98
+ let id = useId();
99
+
100
+ let commonProps = {
101
+ "data-size": size,
102
+ label: parameter.label,
103
+ description: parameter.description ?? undefined,
104
+ readOnly,
105
+ };
106
+
107
+ switch (parameter.editor) {
108
+ case "boolean":
109
+ return (
110
+ <div className="ObReportParameters-field">
111
+ <Checkbox
112
+ data-size={size}
113
+ label={parameter.label}
114
+ description={parameter.description ?? undefined}
115
+ disabled={readOnly}
116
+ checked={value === true}
117
+ onChange={(event) => onChange(event.target.checked)}
118
+ />
119
+ </div>
120
+ );
121
+
122
+ case "select":
123
+ return (
124
+ <div className="ObReportParameters-field">
125
+ <Field data-size={size}>
126
+ <Label htmlFor={id}>{parameter.label}</Label>
127
+ {parameter.description && <FieldDescription>{parameter.description}</FieldDescription>}
128
+ <Select
129
+ id={id}
130
+ readOnly={readOnly}
131
+ value={value === null ? "" : String(value)}
132
+ onChange={(event) => onChange(coerceParameterValue(parameter, event.currentTarget.value))}
133
+ >
134
+ <Select.Option value="">{getLocalizedString("Not selected")}</Select.Option>
135
+ {parameter.items.map((item) => (
136
+ <Select.Option key={item} value={item}>
137
+ {item}
138
+ </Select.Option>
139
+ ))}
140
+ </Select>
141
+ </Field>
142
+ </div>
143
+ );
144
+
145
+ case "lookup":
146
+ return (
147
+ <div className="ObReportParameters-field">
148
+ <Combobox
149
+ {...commonProps}
150
+ loading={loading}
151
+ options={options}
152
+ value={options.find((option) => option.value === String(value ?? "")) ?? null}
153
+ getOptionLabel={(option) => option.label}
154
+ getOptionKey={(option) => option.value}
155
+ isOptionEqualToValue={(option, selected) => option.value === selected.value}
156
+ onChange={(_event, option) => onChange(option ? coerceParameterValue(parameter, option.value) : null)}
157
+ />
158
+ </div>
159
+ );
160
+
161
+ case "number":
162
+ return (
163
+ <div className="ObReportParameters-field">
164
+ <Textfield
165
+ {...commonProps}
166
+ type="number"
167
+ // The designer's `Double` parameters are free-form decimals.
168
+ step={parameter.type === "Integer" ? 1 : "any"}
169
+ value={value === null ? "" : String(value)}
170
+ onChange={(event) => onChange(coerceParameterValue(parameter, event.target.value))}
171
+ />
172
+ </div>
173
+ );
174
+
175
+ case "date":
176
+ return (
177
+ <div className="ObReportParameters-field">
178
+ <Textfield
179
+ {...commonProps}
180
+ type="date"
181
+ value={value === null ? "" : String(value)}
182
+ onChange={(event) => onChange(event.target.value === "" ? null : event.target.value)}
183
+ />
184
+ </div>
185
+ );
186
+
187
+ default:
188
+ return (
189
+ <div className="ObReportParameters-field">
190
+ <Textfield
191
+ {...commonProps}
192
+ value={value === null ? "" : String(value)}
193
+ onChange={(event) => onChange(event.target.value === "" ? null : event.target.value)}
194
+ />
195
+ </div>
196
+ );
197
+ }
198
+ }
@@ -0,0 +1,2 @@
1
+ export { ReportLauncher, type ReportLauncherProps, type ReportLauncherTab } from "./ReportLauncher.js";
2
+ export { ReportParameterField, ReportParameters, type ReportParametersProps } from "./ReportParameters.js";
@@ -0,0 +1,8 @@
1
+ import "@testing-library/jest-dom/vitest";
2
+
3
+ import { cleanup } from "@testing-library/react";
4
+ import { afterEach } from "vitest";
5
+
6
+ afterEach(() => {
7
+ cleanup();
8
+ });