@olenbetong/synergi-react 5.0.0 → 5.2.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 (168) hide show
  1. package/dist/styles/styles.css +1 -1
  2. package/dist/styles/styles.css.map +1 -1
  3. package/es/components/Checkbox/index.css +1 -1
  4. package/es/components/Checkbox/index.js +1 -9
  5. package/es/components/CodeEditor/CodeEditor.css +6 -6
  6. package/es/components/ColorCard/index.css +17 -28
  7. package/es/components/DateNavigator/index.css +5 -7
  8. package/es/components/FilePond.js +3 -12
  9. package/es/components/ImageEditor/ImageEditor.css +10 -10
  10. package/es/components/ImageEditor/ImageEditor.js +4 -4
  11. package/es/components/ImageEditor/ResponsiveButton.js +2 -2
  12. package/es/components/ImageEditor/plugins/cropPlugin/CropToolbar.js +1 -1
  13. package/es/components/ImageEditor/plugins/redactPlugin/RedactToolbar.js +1 -1
  14. package/es/components/ImageEditor/plugins/redactPlugin/useRedactTool.js +18 -14
  15. package/es/components/ImageEditor/useImageHistory.js +13 -1
  16. package/es/components/MergeProgressDialog/MergeProgressDialogDs.js +3 -3
  17. package/es/components/MergeProgressDialog/useMergeJob.js +5 -4
  18. package/es/components/PageBanner/index.css +1 -1
  19. package/es/components/PdfViewer/PdfViewer.js +1 -1
  20. package/es/components/Portal/index.js +20 -20
  21. package/es/components/Spinner/index.css +1 -1
  22. package/es/components/SplitContainer/index.css +1 -1
  23. package/es/components/SplitContainer/index.js +3 -1
  24. package/es/components/Toolbar/Toolbar.css +137 -137
  25. package/es/components/Toolbar/index.js +6 -1
  26. package/es/components/ValueToggleGroup/index.css +2 -2
  27. package/es/elements/ElementLookupDialog/BarcodeScanner/BarcodeScanner.css +7 -7
  28. package/es/elements/ElementLookupDialog/BarcodeScanner/decoders/zxing.js +8 -0
  29. package/es/elements/ElementLookupDialog/HIDScanner/useHIDScanner.js +3 -1
  30. package/es/elements-ds/DescriptionInput.d.ts +16 -0
  31. package/es/elements-ds/DescriptionInput.js +41 -0
  32. package/es/elements-ds/DuplicateElementDamage.d.ts +40 -0
  33. package/es/elements-ds/DuplicateElementDamage.js +57 -0
  34. package/es/elements-ds/ElementLookup.d.ts +23 -0
  35. package/es/elements-ds/ElementLookup.js +35 -0
  36. package/es/elements-ds/ElementLookupDialog.d.ts +7 -0
  37. package/es/elements-ds/ElementLookupDialog.js +84 -0
  38. package/es/elements-ds/FormFields.d.ts +43 -0
  39. package/es/elements-ds/FormFields.js +67 -0
  40. package/es/elements-ds/HIDScanner.d.ts +7 -0
  41. package/es/elements-ds/HIDScanner.js +36 -0
  42. package/es/elements-ds/ManualForm.d.ts +7 -0
  43. package/es/elements-ds/ManualForm.js +70 -0
  44. package/es/elements-ds/ProjectSelect.d.ts +28 -0
  45. package/es/elements-ds/ProjectSelect.js +45 -0
  46. package/es/elements-ds/elements-ds.css +157 -0
  47. package/es/elements-ds/index.d.ts +12 -0
  48. package/es/elements-ds/index.js +14 -0
  49. package/es/index.css +1 -1
  50. package/es/useTranslation/index.js +5 -3
  51. package/package.json +16 -4
  52. package/src/chrome/AppShell/AppShell.test.tsx +48 -0
  53. package/src/chrome/AppShell/index.tsx +29 -29
  54. package/src/chrome/openReport.test.ts +50 -0
  55. package/src/chrome/openReport.ts +34 -34
  56. package/src/colorScheme.test.ts +188 -0
  57. package/src/colorScheme.ts +125 -125
  58. package/src/components/Checkbox/Checkbox.browser.test.tsx +116 -0
  59. package/src/components/Checkbox/index.scss +2 -2
  60. package/src/components/Checkbox/index.tsx +1 -10
  61. package/src/components/CodeEditor/CodeEditor.css +6 -6
  62. package/src/components/CodeEditor/CodeEditor.tsx +173 -173
  63. package/src/components/CodeEditor/index.ts +1 -1
  64. package/src/components/ColorCard/ColorCard.test.tsx +34 -0
  65. package/src/components/ColorCard/index.css +17 -28
  66. package/src/components/DateNavigator/DateNavigator.test.tsx +175 -0
  67. package/src/components/DateNavigator/index.css +5 -7
  68. package/src/components/DateNavigator/index.tsx +186 -186
  69. package/src/components/FilePond.browser.test.tsx +389 -0
  70. package/src/components/FilePond.tsx +303 -312
  71. package/src/components/ImageEditor/ImageEditor.browser.test.tsx +286 -0
  72. package/src/components/ImageEditor/ImageEditor.css +10 -10
  73. package/src/components/ImageEditor/ImageEditor.test.tsx +299 -0
  74. package/src/components/ImageEditor/ImageEditor.tsx +348 -348
  75. package/src/components/ImageEditor/ResponsiveButton.tsx +2 -2
  76. package/src/components/ImageEditor/index.ts +9 -9
  77. package/src/components/ImageEditor/plugins/cropPlugin/CropOverlay.tsx +165 -165
  78. package/src/components/ImageEditor/plugins/cropPlugin/CropToolbar.tsx +42 -48
  79. package/src/components/ImageEditor/plugins/cropPlugin/useCropTool.test.ts +225 -0
  80. package/src/components/ImageEditor/plugins/cropPlugin/useCropTool.ts +405 -405
  81. package/src/components/ImageEditor/plugins/plugins.browser.test.ts +252 -0
  82. package/src/components/ImageEditor/plugins/redactPlugin/RedactToolbar.tsx +47 -47
  83. package/src/components/ImageEditor/plugins/redactPlugin/useRedactTool.test.ts +89 -0
  84. package/src/components/ImageEditor/plugins/redactPlugin/useRedactTool.ts +16 -13
  85. package/src/components/ImageEditor/plugins/zoomPlugin/ZoomContext.tsx +23 -23
  86. package/src/components/ImageEditor/plugins/zoomPlugin/ZoomControls.tsx +40 -40
  87. package/src/components/ImageEditor/plugins/zoomPlugin/useZoomPan.test.ts +154 -0
  88. package/src/components/ImageEditor/useActiveTool.ts +21 -21
  89. package/src/components/ImageEditor/useEdgeDetection.test.ts +96 -0
  90. package/src/components/ImageEditor/useEdgeDetection.ts +319 -319
  91. package/src/components/ImageEditor/useImageHistory.test.ts +409 -0
  92. package/src/components/ImageEditor/useImageHistory.ts +206 -197
  93. package/src/components/ImageEditor/useOpenCV.test.ts +208 -0
  94. package/src/components/ImageEditor/useOpenCV.ts +184 -184
  95. package/src/components/LinkedCardList/index.scss +95 -95
  96. package/src/components/MergeProgressDialog/MergeProgressDialogDs.browser.test.tsx +156 -0
  97. package/src/components/MergeProgressDialog/MergeProgressDialogDs.tsx +4 -3
  98. package/src/components/MergeProgressDialog/useMergeJob.test.ts +326 -0
  99. package/src/components/MergeProgressDialog/useMergeJob.ts +4 -3
  100. package/src/components/PageBanner/index.scss +10 -10
  101. package/src/components/PageBanner/index.tsx +80 -80
  102. package/src/components/PdfViewer/PdfViewer.browser.test.tsx +78 -0
  103. package/src/components/PdfViewer/PdfViewer.tsx +158 -158
  104. package/src/components/Portal/Portal.test.tsx +106 -0
  105. package/src/components/Portal/index.tsx +22 -25
  106. package/src/components/Sidebar/Sidebar.browser.test.tsx +57 -0
  107. package/src/components/Sidebar/Sidebar.test.tsx +123 -0
  108. package/src/components/Spinner/index.css +1 -1
  109. package/src/components/SplitContainer/SplitContainer.browser.test.tsx +304 -0
  110. package/src/components/SplitContainer/index.scss +5 -1
  111. package/src/components/SplitContainer/index.tsx +335 -333
  112. package/src/components/Toolbar/Toolbar.css +137 -137
  113. package/src/components/Toolbar/Toolbar.test.tsx +216 -0
  114. package/src/components/Toolbar/ToolbarBreadcrumbs.browser.test.tsx +137 -0
  115. package/src/components/Toolbar/index.tsx +270 -265
  116. package/src/components/ValueToggleGroup/ValueToggleGroup.test.tsx +112 -0
  117. package/src/components/ValueToggleGroup/index.css +2 -2
  118. package/src/designsystemet-web-types.d.ts +24 -24
  119. package/src/elements/ElementDamage/DamageFormButtons.tsx +35 -35
  120. package/src/elements/ElementDamage/DescriptionInput.tsx +120 -120
  121. package/src/elements/ElementDamage/DuplicateDamage/DesktopView.tsx +82 -82
  122. package/src/elements/ElementDamage/DuplicateDamage/DublicateElementDamageDialog.tsx +67 -67
  123. package/src/elements/ElementDamage/DuplicateDamage/PhoneView.tsx +45 -45
  124. package/src/elements/ElementDamage/ElementNumberTextField.tsx +41 -41
  125. package/src/elements/ElementDamage/RegisterFix.tsx +100 -100
  126. package/src/elements/ElementDamage/SubmitButtons.tsx +40 -40
  127. package/src/elements/ElementDamage/TransportElementSelect.tsx +52 -52
  128. package/src/elements/ElementLookup.tsx +123 -123
  129. package/src/elements/ElementLookupDialog/BarcodeScanner/BarcodeScanner.browser.test.tsx +175 -0
  130. package/src/elements/ElementLookupDialog/BarcodeScanner/BarcodeScanner.css +7 -7
  131. package/src/elements/ElementLookupDialog/BarcodeScanner/decoders/zxing.ts +8 -0
  132. package/src/elements/ElementLookupDialog/BarcodeScanner/engines.browser.test.ts +225 -0
  133. package/src/elements/ElementLookupDialog/HIDScanner/index.tsx +67 -67
  134. package/src/elements/ElementLookupDialog/HIDScanner/useHIDScanner.test.ts +124 -0
  135. package/src/elements/ElementLookupDialog/HIDScanner/useHIDScanner.ts +2 -1
  136. package/src/elements/ElementLookupDialog/Manual/ManualForm.tsx +141 -141
  137. package/src/elements/ElementLookupDialog/getElement.test.ts +133 -0
  138. package/src/elements/ElementLookupDialog/index.tsx +226 -226
  139. package/src/elements/ElementLookupDialog/utils/Giai.test.ts +53 -0
  140. package/src/elements/ElementLookupDialog/utils/Giai.ts +209 -209
  141. package/src/elements/ProjectSelect.tsx +130 -130
  142. package/src/elements/index.ts +15 -15
  143. package/src/elements-ds/DamageForm.browser.test.tsx +530 -0
  144. package/src/elements-ds/DescriptionInput.tsx +114 -0
  145. package/src/elements-ds/DuplicateElementDamage.tsx +185 -0
  146. package/src/elements-ds/ElementLookup.tsx +114 -0
  147. package/src/elements-ds/ElementLookupDialog.browser.test.tsx +207 -0
  148. package/src/elements-ds/ElementLookupDialog.tsx +194 -0
  149. package/src/elements-ds/FormFields.tsx +176 -0
  150. package/src/elements-ds/HIDScanner.tsx +53 -0
  151. package/src/elements-ds/ManualForm.tsx +129 -0
  152. package/src/elements-ds/ProjectSelect.tsx +120 -0
  153. package/src/elements-ds/elements-ds.css +157 -0
  154. package/src/elements-ds/index.ts +16 -0
  155. package/src/filter/index.ts +34 -34
  156. package/src/i18n.test.ts +31 -0
  157. package/src/i18n.ts +13 -13
  158. package/src/mui/MuiThemeProvider.tsx +135 -135
  159. package/src/test/fakeCamera.ts +98 -0
  160. package/src/test/fakeDataApi.ts +90 -0
  161. package/src/test/setup.browser.ts +21 -0
  162. package/src/test/setup.ts +23 -23
  163. package/src/useTranslation/index.ts +5 -3
  164. package/src/useTranslation/useTranslation.test.ts +128 -0
  165. package/es/elements/ElementLookupDialog/BarcodeScanner/decoders.test.d.ts +0 -1
  166. package/es/elements/ElementLookupDialog/BarcodeScanner/decoders.test.js +0 -103
  167. package/es/test/setup.d.ts +0 -6
  168. package/es/test/setup.js +0 -6
@@ -0,0 +1,225 @@
1
+ import { afterEach, describe, expect, it, vi } from "vitest";
2
+
3
+ import { createDbrDecoder } from "./decoders/dbr";
4
+ import { createNativeDecoder, isNativeDecoderAvailable } from "./decoders/native";
5
+
6
+ const GS1_LABEL = "8004704321012345";
7
+
8
+ let globals = window as unknown as Record<string, unknown>;
9
+
10
+ /*
11
+ * A stand-in for the Dynamsoft Barcode Reader 6 SDK, served as a real script so the loader's
12
+ * script-tag path runs. It records what the decoder configures and decodes one GS1 label.
13
+ */
14
+ function fakeDbrScript() {
15
+ let source = `
16
+ window.__dbr = { created: 0, deleted: 0, settings: null };
17
+ window.BarcodeReader = {
18
+ licenseKey: null,
19
+ EnumBarcodeFormat: { DATAMATRIX: 134217728, ALL: -1 },
20
+ async createInstance() {
21
+ window.__dbr.created++;
22
+ let settings = { mBarcodeFormatIds: -1, mAntiDamageLevel: 0, mDeblurLevel: 9 };
23
+ return {
24
+ getRuntimeSettings: () => ({ ...settings }),
25
+ async updateRuntimeSettings(next) { window.__dbr.settings = next; },
26
+ async decode() {
27
+ return [{
28
+ BarcodeText: "${GS1_LABEL}",
29
+ BarcodeFormat: 134217728,
30
+ LocalizationResult: { X1: 1, Y1: 2, X2: 3, Y2: 4, X3: 5, Y3: 6, X4: 7, Y4: 8 },
31
+ }];
32
+ },
33
+ deleteInstance() { window.__dbr.deleted++; },
34
+ };
35
+ },
36
+ };
37
+ `;
38
+ return URL.createObjectURL(new Blob([source], { type: "text/javascript" }));
39
+ }
40
+
41
+ function scriptsFor(url: string) {
42
+ return document.head.querySelectorAll(`script[src="${url}"]`).length;
43
+ }
44
+
45
+ afterEach(() => {
46
+ delete globals.BarcodeReader;
47
+ delete globals.__dbr;
48
+ delete globals.BarcodeDetector;
49
+ });
50
+
51
+ /*
52
+ * The DBR loader remembers a successful load for the page's lifetime, so the failure cases run
53
+ * before the ones that load the SDK.
54
+ */
55
+ describe("Dynamsoft engine (dbr)", () => {
56
+ it("reports a script that cannot be loaded, and tries again next time", async () => {
57
+ let missing = `${location.origin}/no-such-dbr-${Date.now()}.js`;
58
+
59
+ await expect(createDbrDecoder({ scriptUrl: missing, licenseKey: "key" })()).rejects.toThrow(
60
+ `Failed to load ${missing}`,
61
+ );
62
+ expect(scriptsFor(missing)).toBe(0);
63
+
64
+ let url = fakeDbrScript();
65
+ let decoder = await createDbrDecoder({ scriptUrl: url, licenseKey: "key" })();
66
+ expect(decoder.name).toBe("dbr");
67
+ });
68
+
69
+ it("uses an SDK the page has already loaded instead of loading another", async () => {
70
+ let url = fakeDbrScript();
71
+ // Load it the way an article used to: a script tag in the page.
72
+ await new Promise<void>((resolve) => {
73
+ let script = document.createElement("script");
74
+ script.src = url;
75
+ script.onload = () => resolve();
76
+ document.head.append(script);
77
+ });
78
+
79
+ await createDbrDecoder({ scriptUrl: "/lib/dbr/should-not-load.js", licenseKey: "key" })();
80
+
81
+ expect(scriptsFor("/lib/dbr/should-not-load.js")).toBe(0);
82
+ });
83
+
84
+ it("sets the licence, reads DataMatrix only and maps what it finds", async () => {
85
+ let url = fakeDbrScript();
86
+ await new Promise<void>((resolve) => {
87
+ let script = document.createElement("script");
88
+ script.src = url;
89
+ script.onload = () => resolve();
90
+ document.head.append(script);
91
+ });
92
+
93
+ let decoder = await createDbrDecoder({ scriptUrl: url, licenseKey: "license-123" })();
94
+ let results = await decoder.decodeFrame(document.createElement("canvas"));
95
+
96
+ let sdk = globals.BarcodeReader as { licenseKey: string };
97
+ let recorded = globals.__dbr as { settings: Record<string, number>; deleted: number };
98
+ expect(sdk.licenseKey).toBe("license-123");
99
+ expect(recorded.settings).toMatchObject({ mBarcodeFormatIds: 134217728, mAntiDamageLevel: 3, mDeblurLevel: 0 });
100
+ expect(results).toEqual([
101
+ {
102
+ text: GS1_LABEL,
103
+ format: "134217728",
104
+ corners: [
105
+ { x: 1, y: 2 },
106
+ { x: 3, y: 4 },
107
+ { x: 5, y: 6 },
108
+ { x: 7, y: 8 },
109
+ ],
110
+ },
111
+ ]);
112
+
113
+ decoder.dispose?.();
114
+ expect(recorded.deleted).toBe(1);
115
+ });
116
+ });
117
+
118
+ /** A stand-in for the Barcode Detection API as Chrome on Android exposes it. */
119
+ function installBarcodeDetector(formats: string[], detected: unknown[] = []) {
120
+ let constructed: unknown[] = [];
121
+ class FakeBarcodeDetector {
122
+ static getSupportedFormats = vi.fn(async () => formats);
123
+ constructor(options: unknown) {
124
+ constructed.push(options);
125
+ }
126
+ detect = vi.fn(async () => detected);
127
+ }
128
+ globals.BarcodeDetector = FakeBarcodeDetector;
129
+ return { constructed };
130
+ }
131
+
132
+ describe("native engine (Barcode Detection API)", () => {
133
+ it("is unavailable where the browser has no BarcodeDetector", async () => {
134
+ expect(await isNativeDecoderAvailable()).toBe(false);
135
+ await expect(createNativeDecoder()()).rejects.toThrow("This browser cannot detect barcodes natively");
136
+ });
137
+
138
+ it("is unavailable where BarcodeDetector cannot read DataMatrix, as on desktop Chrome", async () => {
139
+ installBarcodeDetector(["qr_code"]);
140
+
141
+ expect(await isNativeDecoderAvailable()).toBe(false);
142
+ });
143
+
144
+ it("is unavailable when asking for the formats fails", async () => {
145
+ installBarcodeDetector([]);
146
+ (globals.BarcodeDetector as { getSupportedFormats: () => Promise<string[]> }).getSupportedFormats = async () => {
147
+ throw new Error("not allowed");
148
+ };
149
+
150
+ expect(await isNativeDecoderAvailable()).toBe(false);
151
+ });
152
+
153
+ it("reads DataMatrix only, and maps the corners it reports", async () => {
154
+ let { constructed } = installBarcodeDetector(
155
+ ["qr_code", "data_matrix"],
156
+ [
157
+ {
158
+ rawValue: GS1_LABEL,
159
+ format: "data_matrix",
160
+ boundingBox: { left: 0, top: 0, right: 10, bottom: 10 },
161
+ cornerPoints: [
162
+ { x: 1, y: 2 },
163
+ { x: 3, y: 4 },
164
+ { x: 5, y: 6 },
165
+ { x: 7, y: 8 },
166
+ ],
167
+ },
168
+ ],
169
+ );
170
+
171
+ let decoder = await createNativeDecoder()();
172
+ let results = await decoder.decodeFrame(document.createElement("canvas"));
173
+
174
+ expect(decoder.name).toBe("native");
175
+ expect(constructed).toEqual([{ formats: ["data_matrix"] }]);
176
+ expect(results[0]).toMatchObject({ text: GS1_LABEL, format: "data_matrix" });
177
+ expect(results[0]!.corners[2]).toEqual({ x: 5, y: 6 });
178
+ });
179
+
180
+ it("falls back to the bounding box when the corners are missing", async () => {
181
+ installBarcodeDetector(
182
+ ["data_matrix"],
183
+ [
184
+ {
185
+ rawValue: GS1_LABEL,
186
+ format: "data_matrix",
187
+ boundingBox: { left: 10, top: 20, right: 110, bottom: 120 },
188
+ cornerPoints: [],
189
+ },
190
+ ],
191
+ );
192
+
193
+ let decoder = await createNativeDecoder()();
194
+ let [result] = await decoder.decodeFrame(document.createElement("canvas"));
195
+
196
+ expect(result!.corners).toEqual([
197
+ { x: 10, y: 20 },
198
+ { x: 110, y: 20 },
199
+ { x: 110, y: 120 },
200
+ { x: 10, y: 120 },
201
+ ]);
202
+ });
203
+
204
+ it("decodes a photo as well as camera frames", async () => {
205
+ installBarcodeDetector(
206
+ ["data_matrix"],
207
+ [
208
+ {
209
+ rawValue: GS1_LABEL,
210
+ format: "data_matrix",
211
+ boundingBox: { left: 0, top: 0, right: 1, bottom: 1 },
212
+ cornerPoints: [],
213
+ },
214
+ ],
215
+ );
216
+ let canvas = new OffscreenCanvas(8, 8);
217
+ canvas.getContext("2d")!.fillRect(0, 0, 8, 8);
218
+ let photo = await canvas.convertToBlob({ type: "image/png" });
219
+
220
+ let decoder = await createNativeDecoder()();
221
+ let results = await decoder.decodeImage(photo);
222
+
223
+ expect(results.map((r) => r.text)).toEqual([GS1_LABEL]);
224
+ });
225
+ });
@@ -1,67 +1,67 @@
1
- import "./index.css";
2
-
3
- import { Box, Button } from "@mui/material";
4
-
5
- import { useEffect, useRef, useState } from "react";
6
-
7
- import { useHIDScanner } from "./useHIDScanner";
8
- import { getLocalizedString } from "../../../i18n.js";
9
-
10
- export function AddElementHIDScanner({ onScan }: { onScan: (id: string) => void }) {
11
- let [enabled, setEnabled] = useState(false);
12
- let root = useRef<HTMLDivElement>(null);
13
-
14
- useEffect(() => {
15
- if (!root.current) return;
16
-
17
- let rootElem = root.current;
18
-
19
- function handleFocus() {
20
- setEnabled(true);
21
- }
22
-
23
- function handleBlur() {
24
- setEnabled(false);
25
- }
26
-
27
- rootElem.addEventListener("focus", handleFocus);
28
- rootElem.addEventListener("blur", handleBlur);
29
- rootElem.focus();
30
-
31
- return () => {
32
- rootElem.removeEventListener("focus", handleFocus);
33
- rootElem.removeEventListener("blur", handleBlur);
34
- };
35
- }, []);
36
-
37
- useHIDScanner(onScan, enabled);
38
-
39
- return (
40
- <Box
41
- sx={{
42
- height: "100%",
43
- bgcolor: "#ddd",
44
- display: "flex",
45
- alignItems: "center",
46
- justifyContent: "center",
47
- backgroundImage: enabled ? "linear-gradient(var(--angle), #777, #bbb, #777)" : "none",
48
- animation: enabled ? "MovingBackground 8s linear infinite" : "none",
49
- }}
50
- tabIndex={0}
51
- ref={root}
52
- >
53
- {enabled ? (
54
- <span>{getLocalizedString("Listening for scanned elements")}...</span>
55
- ) : (
56
- <Button
57
- variant="contained"
58
- onClick={() => {
59
- if (root.current) root.current.focus();
60
- }}
61
- >
62
- {getLocalizedString("Start listening")}
63
- </Button>
64
- )}
65
- </Box>
66
- );
67
- }
1
+ import "./index.css";
2
+
3
+ import { Box, Button } from "@mui/material";
4
+
5
+ import { useEffect, useRef, useState } from "react";
6
+
7
+ import { useHIDScanner } from "./useHIDScanner";
8
+ import { getLocalizedString } from "../../../i18n.js";
9
+
10
+ export function AddElementHIDScanner({ onScan }: { onScan: (id: string) => void }) {
11
+ let [enabled, setEnabled] = useState(false);
12
+ let root = useRef<HTMLDivElement>(null);
13
+
14
+ useEffect(() => {
15
+ if (!root.current) return;
16
+
17
+ let rootElem = root.current;
18
+
19
+ function handleFocus() {
20
+ setEnabled(true);
21
+ }
22
+
23
+ function handleBlur() {
24
+ setEnabled(false);
25
+ }
26
+
27
+ rootElem.addEventListener("focus", handleFocus);
28
+ rootElem.addEventListener("blur", handleBlur);
29
+ rootElem.focus();
30
+
31
+ return () => {
32
+ rootElem.removeEventListener("focus", handleFocus);
33
+ rootElem.removeEventListener("blur", handleBlur);
34
+ };
35
+ }, []);
36
+
37
+ useHIDScanner(onScan, enabled);
38
+
39
+ return (
40
+ <Box
41
+ sx={{
42
+ height: "100%",
43
+ bgcolor: "#ddd",
44
+ display: "flex",
45
+ alignItems: "center",
46
+ justifyContent: "center",
47
+ backgroundImage: enabled ? "linear-gradient(var(--angle), #777, #bbb, #777)" : "none",
48
+ animation: enabled ? "MovingBackground 8s linear infinite" : "none",
49
+ }}
50
+ tabIndex={0}
51
+ ref={root}
52
+ >
53
+ {enabled ? (
54
+ <span>{getLocalizedString("Listening for scanned elements")}...</span>
55
+ ) : (
56
+ <Button
57
+ variant="contained"
58
+ onClick={() => {
59
+ if (root.current) root.current.focus();
60
+ }}
61
+ >
62
+ {getLocalizedString("Start listening")}
63
+ </Button>
64
+ )}
65
+ </Box>
66
+ );
67
+ }
@@ -0,0 +1,124 @@
1
+ import { renderHook } from "@testing-library/react";
2
+ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
3
+
4
+ import { useHIDScanner } from "./useHIDScanner";
5
+
6
+ /** A GIAI-96 tag as an RFID reader in keyboard (HID) mode types it: the EPC in hex, then Enter. */
7
+ const EPC = "3415ADE22800000000003039";
8
+
9
+ function type(text: string) {
10
+ for (let key of text) {
11
+ document.body.dispatchEvent(new KeyboardEvent("keydown", { key, bubbles: true }));
12
+ }
13
+ }
14
+
15
+ function pressEnter() {
16
+ document.body.dispatchEvent(new KeyboardEvent("keydown", { key: "Enter", bubbles: true }));
17
+ }
18
+
19
+ beforeEach(() => {
20
+ vi.useFakeTimers();
21
+ });
22
+
23
+ afterEach(() => {
24
+ vi.useRealTimers();
25
+ });
26
+
27
+ describe("useHIDScanner", () => {
28
+ it("reads what the scanner types up to Enter", () => {
29
+ let onRead = vi.fn();
30
+ renderHook(() => useHIDScanner(onRead, true));
31
+
32
+ type(EPC);
33
+ pressEnter();
34
+
35
+ expect(onRead).toHaveBeenCalledExactlyOnceWith(EPC);
36
+ });
37
+
38
+ it("reads scans one after another", () => {
39
+ let onRead = vi.fn();
40
+ renderHook(() => useHIDScanner(onRead, true));
41
+
42
+ type(EPC);
43
+ pressEnter();
44
+ type("8004704321012345");
45
+ pressEnter();
46
+
47
+ expect(onRead.mock.calls).toEqual([[EPC], ["8004704321012345"]]);
48
+ });
49
+
50
+ it("keeps the 0x prefix some readers send", () => {
51
+ let onRead = vi.fn();
52
+ renderHook(() => useHIDScanner(onRead, true));
53
+
54
+ type(`0x${EPC}`);
55
+ pressEnter();
56
+
57
+ expect(onRead).toHaveBeenCalledWith(`0x${EPC}`);
58
+ });
59
+
60
+ it("drops keys that cannot be part of a tag", () => {
61
+ let onRead = vi.fn();
62
+ renderHook(() => useHIDScanner(onRead, true));
63
+
64
+ type("34-15 ADE2");
65
+ pressEnter();
66
+
67
+ expect(onRead).toHaveBeenCalledWith("3415ADE2");
68
+ });
69
+
70
+ it("forgets a partial read after half a second without keys", () => {
71
+ let onRead = vi.fn();
72
+ renderHook(() => useHIDScanner(onRead, true));
73
+
74
+ type("3415");
75
+ vi.advanceTimersByTime(600);
76
+ type(EPC);
77
+ pressEnter();
78
+
79
+ expect(onRead).toHaveBeenCalledExactlyOnceWith(EPC);
80
+ });
81
+
82
+ it("keeps reading while the keys come quickly", () => {
83
+ let onRead = vi.fn();
84
+ renderHook(() => useHIDScanner(onRead, true));
85
+
86
+ for (let key of EPC) {
87
+ type(key);
88
+ vi.advanceTimersByTime(400);
89
+ }
90
+ pressEnter();
91
+
92
+ expect(onRead).toHaveBeenCalledWith(EPC);
93
+ });
94
+
95
+ it("ignores Enter with nothing scanned", () => {
96
+ let onRead = vi.fn();
97
+ renderHook(() => useHIDScanner(onRead, true));
98
+
99
+ pressEnter();
100
+
101
+ expect(onRead).not.toHaveBeenCalled();
102
+ });
103
+
104
+ it("listens only while enabled", () => {
105
+ let onRead = vi.fn();
106
+ let { rerender, unmount } = renderHook(({ enabled }) => useHIDScanner(onRead, enabled), {
107
+ initialProps: { enabled: false },
108
+ });
109
+
110
+ type(EPC);
111
+ pressEnter();
112
+ expect(onRead).not.toHaveBeenCalled();
113
+
114
+ rerender({ enabled: true });
115
+ type(EPC);
116
+ pressEnter();
117
+ expect(onRead).toHaveBeenCalledOnce();
118
+
119
+ unmount();
120
+ type(EPC);
121
+ pressEnter();
122
+ expect(onRead).toHaveBeenCalledOnce();
123
+ });
124
+ });
@@ -16,7 +16,8 @@ export function useHIDScanner(onRead: (value: string) => void, enabled = false)
16
16
  buffer = "";
17
17
  }, 500);
18
18
  } else if (event.key === "Enter") {
19
- onRead(buffer);
19
+ // An Enter with nothing scanned (a stray key press) is not a read.
20
+ if (buffer) onRead(buffer);
20
21
  buffer = "";
21
22
  }
22
23
  }