@olenbetong/appframe-ds 1.2.0 → 1.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (177) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/package.json +7 -7
  3. package/scripts/copyAssets.mjs +27 -27
  4. package/src/AfLookup/Lookup.css +129 -129
  5. package/src/AfLookup/Lookup.tsx +184 -184
  6. package/src/AfLookup/LookupCombobox.css +78 -78
  7. package/src/AfLookup/LookupCombobox.tsx +237 -237
  8. package/src/AfLookup/LookupEdit.tsx +130 -130
  9. package/src/AfLookup/LookupGrid.tsx +124 -124
  10. package/src/AfLookup/index.ts +5 -5
  11. package/src/autocomplete/Autocomplete.css +256 -256
  12. package/src/autocomplete/Autocomplete.tsx +320 -320
  13. package/src/autocomplete/AutocompleteFrame.tsx +168 -168
  14. package/src/autocomplete/Combobox.tsx +286 -286
  15. package/src/autocomplete/index.ts +4 -4
  16. package/src/autocomplete/types.ts +204 -204
  17. package/src/autocomplete/utils.ts +183 -183
  18. package/src/binding/BoundNumericTextField.tsx +102 -102
  19. package/src/binding/BoundTextField.tsx +49 -49
  20. package/src/binding/CancelButton.tsx +30 -30
  21. package/src/binding/CancelIconButton.tsx +30 -30
  22. package/src/binding/DataEditToolbar.css +23 -0
  23. package/src/binding/DataEditToolbar.tsx +84 -92
  24. package/src/binding/DeleteButton.tsx +35 -35
  25. package/src/binding/DeleteIconButton.tsx +35 -35
  26. package/src/binding/RefreshButton.tsx +31 -31
  27. package/src/binding/RefreshIconButton.tsx +33 -33
  28. package/src/binding/RefreshRowIconButton.tsx +33 -33
  29. package/src/binding/SaveButton.tsx +37 -37
  30. package/src/binding/SaveIconButton.tsx +38 -38
  31. package/src/container/Container.tsx +49 -49
  32. package/src/container/index.ts +1 -1
  33. package/src/cutoff/CutOffPicker.css +12 -12
  34. package/src/cutoff/CutOffPicker.tsx +165 -165
  35. package/src/cutoff/context.tsx +194 -194
  36. package/src/cutoff/dsCutOffDates.ts +21 -21
  37. package/src/cutoff/index.ts +4 -4
  38. package/src/cutoff/utils.test.ts +59 -59
  39. package/src/cutoff/utils.ts +276 -276
  40. package/src/filter/ChipListInput.tsx +79 -79
  41. package/src/filter/FieldFilterPanel.css +150 -150
  42. package/src/filter/FieldFilterPanel.tsx +309 -309
  43. package/src/filter/FilterBuilder.css +152 -152
  44. package/src/filter/FilterBuilder.test.tsx +153 -153
  45. package/src/filter/FilterBuilder.tsx +435 -435
  46. package/src/filter/FilterEditor.css +231 -231
  47. package/src/filter/FilterEditor.test.tsx +259 -259
  48. package/src/filter/FilterEditor.tsx +75 -75
  49. package/src/filter/FilterGroupEditor.tsx +160 -160
  50. package/src/filter/FilterNameDialog.css +22 -22
  51. package/src/filter/FilterNameDialog.tsx +81 -81
  52. package/src/filter/FilterRow.tsx +117 -117
  53. package/src/filter/FilterShareDialog.css +28 -28
  54. package/src/filter/FilterShareDialog.tsx +201 -201
  55. package/src/filter/FilterStringField.tsx +78 -78
  56. package/src/filter/FilterValueEditor.tsx +220 -220
  57. package/src/filter/SavedFilterTree.css +107 -107
  58. package/src/filter/SavedFilterTree.test.tsx +94 -94
  59. package/src/filter/SavedFilterTree.tsx +218 -218
  60. package/src/filter/fieldFilter.test.ts +158 -158
  61. package/src/filter/fieldFilter.ts +139 -139
  62. package/src/filter/index.ts +27 -27
  63. package/src/filter/types.ts +38 -38
  64. package/src/filter/useDistinctValues.test.ts +102 -102
  65. package/src/filter/useDistinctValues.ts +230 -230
  66. package/src/global.d.ts +11 -11
  67. package/src/grid/AfGridColumnsPanel.tsx +118 -118
  68. package/src/grid/AfGridContext.tsx +51 -51
  69. package/src/grid/AfGridError.tsx +46 -46
  70. package/src/grid/AfHeaderFilterCell.tsx +147 -147
  71. package/src/grid/AfHeaderFilterPanel.tsx +111 -111
  72. package/src/grid/GridEditLookup.css +12 -12
  73. package/src/grid/GridEditLookup.tsx +121 -121
  74. package/src/grid/Toolbar.tsx +233 -233
  75. package/src/grid/editing.ts +100 -100
  76. package/src/grid/filter.ts +78 -78
  77. package/src/grid/formatters.ts +48 -48
  78. package/src/grid/index.css +245 -245
  79. package/src/grid/index.tsx +503 -489
  80. package/src/grid/license.ts +48 -48
  81. package/src/grid/localization.ts +369 -369
  82. package/src/grid/slots/index.tsx +307 -307
  83. package/src/grid/slots/slots.css +64 -64
  84. package/src/grid/theme.tsx +138 -138
  85. package/src/grid/useAfColumns.tsx +371 -371
  86. package/src/grid/useAfCurrentIndex.ts +63 -63
  87. package/src/grid/useAfData.ts +20 -20
  88. package/src/grid/useAfFilter.ts +160 -160
  89. package/src/grid/useAfFilterFields.ts +55 -55
  90. package/src/grid/useAfGridApi.ts +71 -71
  91. package/src/grid/useAfKeyBindings.ts +36 -36
  92. package/src/grid/useAfNewItemRow.ts +258 -258
  93. package/src/grid/useAfPagination.ts +53 -53
  94. package/src/grid/useAfPersistedState.ts +230 -230
  95. package/src/grid/useAfRowEditModel.ts +145 -145
  96. package/src/grid/useAfRowGrouping.ts +47 -47
  97. package/src/grid/useAfServerAggregation.test.ts +68 -0
  98. package/src/grid/useAfServerAggregation.ts +158 -145
  99. package/src/grid/useAfSortModel.ts +84 -84
  100. package/src/i18n.ts +13 -13
  101. package/src/index.ts +14 -14
  102. package/src/input/InputAdornments.css +84 -75
  103. package/src/input/InputAdornments.tsx +102 -102
  104. package/src/input/index.ts +1 -1
  105. package/src/layout/AppMenu.tsx +74 -74
  106. package/src/layout/AppMenuDrawer.css +70 -70
  107. package/src/layout/AppMenuDrawer.tsx +122 -122
  108. package/src/layout/ErrorBoundary.tsx +162 -162
  109. package/src/layout/PageContainer.css +21 -2
  110. package/src/layout/PageContainer.tsx +18 -2
  111. package/src/layout/ResponsiveDialog.css +86 -86
  112. package/src/layout/ResponsiveDialog.tsx +55 -55
  113. package/src/layout/index.tsx +69 -69
  114. package/src/link/Link.tsx +23 -23
  115. package/src/link/index.ts +1 -1
  116. package/src/mdi/Mdi.css +138 -138
  117. package/src/mdi/Mdi.test.tsx +91 -91
  118. package/src/mdi/Mdi.tsx +141 -141
  119. package/src/mdi/MdiConfirmCloseDialog.tsx +47 -47
  120. package/src/mdi/MdiContext.tsx +59 -59
  121. package/src/mdi/MdiDocumentContext.tsx +60 -60
  122. package/src/mdi/MdiPanel.tsx +61 -61
  123. package/src/mdi/MdiRestore.test.tsx +86 -86
  124. package/src/mdi/MdiTab.tsx +30 -30
  125. package/src/mdi/controller.test.ts +382 -382
  126. package/src/mdi/controller.ts +656 -656
  127. package/src/mdi/dockviewHost.ts +132 -132
  128. package/src/mdi/fakeHost.ts +200 -200
  129. package/src/mdi/host.ts +44 -44
  130. package/src/mdi/ids.test.ts +20 -20
  131. package/src/mdi/ids.ts +18 -18
  132. package/src/mdi/index.ts +31 -31
  133. package/src/mdi/layoutRestore.test.ts +156 -156
  134. package/src/mdi/layoutRestore.ts +311 -311
  135. package/src/mdi/layoutSpec.test.ts +143 -143
  136. package/src/mdi/layoutSpec.ts +214 -214
  137. package/src/mdi/layoutStore.test.ts +93 -93
  138. package/src/mdi/layoutStore.ts +99 -99
  139. package/src/mdi/memorySettingsStore.ts +21 -21
  140. package/src/mdi/registry.ts +34 -34
  141. package/src/mdi/testTypes.ts +37 -37
  142. package/src/mdi/theme.ts +22 -22
  143. package/src/mdi/types.ts +214 -214
  144. package/src/page/Page.css +53 -53
  145. package/src/page/PageBlock.css +64 -64
  146. package/src/page/PageBlock.tsx +92 -92
  147. package/src/page/PageHeader.css +88 -88
  148. package/src/page/PageHeader.tsx +115 -115
  149. package/src/page/PageTitle.css +5 -5
  150. package/src/page/PageTitle.tsx +21 -21
  151. package/src/page/index.ts +4 -4
  152. package/src/paper/Paper.tsx +52 -52
  153. package/src/progress/LinearProgress.css +93 -93
  154. package/src/progress/LinearProgress.tsx +104 -104
  155. package/src/progress/index.ts +1 -1
  156. package/src/report-downloader/ReportDownloader.css +67 -67
  157. package/src/report-downloader/components/StatusItem.tsx +87 -87
  158. package/src/report-downloader/components/StatusList.tsx +28 -28
  159. package/src/report-downloader/index.ts +41 -41
  160. package/src/report-downloader/status.tsx +92 -92
  161. package/src/sortable/DropIndicator.css +51 -51
  162. package/src/sortable/DropIndicator.tsx +27 -27
  163. package/src/sortable/SortableItemList.css +21 -21
  164. package/src/sortable/SortableItemList.tsx +264 -264
  165. package/src/sortable/index.ts +8 -8
  166. package/src/sortable/reorderSortOrder.ts +126 -126
  167. package/src/sortable/sortOrder.ts +101 -101
  168. package/src/sortable/types.ts +9 -9
  169. package/src/sortable/useSortableContainer.ts +53 -53
  170. package/src/sortable/useSortableItem.ts +95 -95
  171. package/src/sortable/useSortableList.ts +117 -117
  172. package/src/test/happy-dom-document-class.ts +24 -24
  173. package/src/test/setup.ts +12 -12
  174. package/src/theme/useDsColorScheme.ts +53 -53
  175. package/tsconfig.build.json +9 -9
  176. package/tsconfig.json +8 -8
  177. package/vitest.config.ts +10 -10
@@ -1,382 +1,382 @@
1
- import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
2
-
3
- import { MdiController, type MdiControllerOptions } from "./controller.js";
4
- import { createFakeHost } from "./fakeHost.js";
5
- import { layoutSpecToLayout } from "./layoutSpec.js";
6
- import { createLayoutStore, type MdiLayoutStore } from "./layoutStore.js";
7
- import { createMemorySettingsStore } from "./memorySettingsStore.js";
8
- import { testSpec, testTypes } from "./testTypes.js";
9
- import type { MdiConfirmCloseResult, MdiDocumentTypes, MdiLayout, MdiLayoutSpec } from "./types.js";
10
-
11
- function setup(
12
- options: Partial<MdiControllerOptions> = {},
13
- types: MdiDocumentTypes = testTypes,
14
- store?: MdiLayoutStore,
15
- ) {
16
- let fake = createFakeHost();
17
- let confirmClose = vi.fn<(document: unknown) => Promise<MdiConfirmCloseResult>>().mockResolvedValue("discard");
18
- let controller = new MdiController(types, store ?? createLayoutStore(createMemorySettingsStore(), "art"));
19
-
20
- controller.setOptions({
21
- layoutVersion: 1,
22
- defaultLayout: testSpec,
23
- persist: false,
24
- popoutUrl: "/popout",
25
- confirmClose,
26
- ...options,
27
- });
28
- controller.attach(fake.host);
29
-
30
- return { controller, fake, confirmClose };
31
- }
32
-
33
- describe("MdiController", () => {
34
- beforeEach(() => {
35
- vi.spyOn(console, "warn").mockImplementation(() => {});
36
- });
37
-
38
- afterEach(() => {
39
- vi.restoreAllMocks();
40
- });
41
-
42
- describe("initialize", () => {
43
- it("applies the default layout", async () => {
44
- let { controller, fake } = setup();
45
-
46
- await controller.initialize();
47
-
48
- expect([...fake.panels.keys()]).toEqual(["explorer", "editor:a", "editor:b", "properties"]);
49
- expect(controller.getDocuments().map((document) => document.id)).toEqual([
50
- "explorer",
51
- "editor:a",
52
- "editor:b",
53
- "properties",
54
- ]);
55
- expect(controller.getActive()?.id).toBe("explorer");
56
- expect(fake.groups.get("mdi-g1")).toMatchObject({ locked: true, headerHidden: true });
57
- });
58
-
59
- it("restores no-drop-target groups after dockview reduced the flag to a boolean", async () => {
60
- let spec: MdiLayoutSpec = {
61
- root: {
62
- direction: "horizontal",
63
- children: [
64
- { tabs: [{ type: "explorer" }], locked: "no-drop-target" },
65
- { tabs: [{ type: "properties" }], locked: true },
66
- ],
67
- },
68
- };
69
- let { controller, fake } = setup({ defaultLayout: spec });
70
-
71
- await controller.initialize();
72
-
73
- expect(fake.groups.get("mdi-g1")?.locked).toBe("no-drop-target");
74
- expect(fake.groups.get("mdi-g2")?.locked).toBe(true);
75
- });
76
-
77
- it("restores a persisted layout and drops documents the resolver rejects", async () => {
78
- let restore = vi.fn(async ({ key }: { key?: string }) => (key === "b" ? false : { title: `Restored ${key}` }));
79
- let types: MdiDocumentTypes = { ...testTypes, editor: { ...testTypes["editor"]!, restore } };
80
- let persisted = layoutSpecToLayout(testSpec, types, 1);
81
- let store = createLayoutStore(createMemorySettingsStore({ "art.dock": persisted }), "art");
82
- let { controller, fake } = setup({ id: "dock", persist: true }, types, store);
83
-
84
- await controller.initialize();
85
-
86
- expect(restore).toHaveBeenCalledTimes(2);
87
- expect([...fake.panels.keys()]).toEqual(["explorer", "editor:a", "properties"]);
88
- expect(controller.getDocument("editor:a")?.title).toBe("Restored a");
89
- expect(fake.panels.get("editor:a")?.title).toBe("Restored a");
90
- });
91
-
92
- it("falls back to the default layout when the version differs", async () => {
93
- let persisted = { ...layoutSpecToLayout(testSpec, testTypes, 1), layoutVersion: 0 };
94
- let store = createLayoutStore(createMemorySettingsStore({ "art.dock": persisted }), "art");
95
- let { controller, fake } = setup({ id: "dock", persist: true }, testTypes, store);
96
-
97
- await controller.initialize();
98
-
99
- expect(fake.panels.size).toBe(4);
100
- });
101
-
102
- it("re-adds fixed panes that are missing from a saved layout", async () => {
103
- let persisted = layoutSpecToLayout(testSpec, testTypes, 1);
104
- delete persisted.documents["properties"];
105
- delete persisted.dockview.panels["properties"];
106
- let store = createLayoutStore(createMemorySettingsStore({ "art.dock": persisted }), "art");
107
- let { controller, fake } = setup({ id: "dock", persist: true }, testTypes, store);
108
-
109
- await controller.initialize();
110
-
111
- expect(fake.panels.has("properties")).toBe(true);
112
- expect(controller.getDocument("properties")).toMatchObject({ closable: false, isActive: false });
113
- });
114
-
115
- it("drops documents whose type is no longer registered", async () => {
116
- let persisted = layoutSpecToLayout(testSpec, testTypes, 1);
117
- let { settings: _settings, ...types } = testTypes;
118
- persisted.documents["ghost"] = { type: "ghost", params: {}, closable: true };
119
- persisted.dockview.panels["ghost"] = { id: "ghost", contentComponent: "mdi" };
120
- let store = createLayoutStore(createMemorySettingsStore({ "art.dock": persisted }), "art");
121
- let { controller, fake } = setup({ id: "dock", persist: true }, types, store);
122
-
123
- await controller.initialize();
124
-
125
- expect(fake.panels.has("ghost")).toBe(false);
126
- expect(controller.getDocument("ghost")).toBeUndefined();
127
- });
128
- });
129
-
130
- describe("opening", () => {
131
- it("opens a keyed document once and activates it on the second call", async () => {
132
- let { controller, fake } = setup();
133
- await controller.initialize();
134
- let opened = vi.fn();
135
- controller.subscribe("open", opened);
136
-
137
- let id = controller.openDocument({ type: "editor", key: "c", params: { name: "C" } });
138
- fake.activate("explorer");
139
- let again = controller.openDocument({ type: "editor", key: "c", params: { name: "C2" } });
140
-
141
- expect(id).toBe("editor:c");
142
- expect(again).toBe(id);
143
- expect(opened).toHaveBeenCalledTimes(1);
144
- expect(fake.panels.size).toBe(5);
145
- expect(controller.getDocument(id)?.params).toEqual({ name: "C2" });
146
- expect(controller.getActive()?.id).toBe(id);
147
- });
148
-
149
- it("ignores the key of singleton types", async () => {
150
- let { controller } = setup();
151
- await controller.initialize();
152
-
153
- expect(controller.openDocument({ type: "settings", key: "whatever" })).toBe("settings");
154
- expect(controller.panelId("settings", "x")).toBe("settings");
155
- expect(controller.panelId("editor", "x")).toBe("editor:x");
156
- });
157
-
158
- it("adds new documents to the active group by default", async () => {
159
- let { controller, fake } = setup();
160
- await controller.initialize();
161
- fake.activate("editor:a");
162
-
163
- controller.openDocument({ type: "editor", key: "d" });
164
-
165
- expect(fake.panels.get("editor:d")?.groupId).toBe(fake.panels.get("editor:a")?.groupId);
166
- });
167
-
168
- it("rejects unknown types", async () => {
169
- let { controller } = setup();
170
- await controller.initialize();
171
-
172
- expect(() => controller.openDocument({ type: "nope" })).toThrow(/unknown document type/);
173
- });
174
- });
175
-
176
- describe("closing", () => {
177
- it("refuses to close unclosable documents unless forced", async () => {
178
- let { controller, fake } = setup();
179
- await controller.initialize();
180
-
181
- expect(await controller.close("explorer")).toBe(false);
182
- expect(fake.panels.has("explorer")).toBe(true);
183
- expect(await controller.close("explorer", { force: true })).toBe(true);
184
- expect(fake.panels.has("explorer")).toBe(false);
185
- });
186
-
187
- it("closes a clean document and reports it", async () => {
188
- let { controller, fake } = setup();
189
- await controller.initialize();
190
- let closed = vi.fn();
191
- controller.subscribe("close", closed);
192
-
193
- expect(await controller.close("editor:a")).toBe(true);
194
- expect(fake.panels.has("editor:a")).toBe(false);
195
- expect(controller.getDocument("editor:a")).toBeUndefined();
196
- expect(closed).toHaveBeenCalledWith(expect.objectContaining({ id: "editor:a" }));
197
- });
198
-
199
- it("lets an onClosing guard veto", async () => {
200
- let { controller, fake } = setup();
201
- await controller.initialize();
202
- let unregister = controller.registerGuards("editor:a", { onClosing: () => false });
203
-
204
- expect(await controller.close("editor:a")).toBe(false);
205
- expect(fake.panels.has("editor:a")).toBe(true);
206
-
207
- unregister();
208
- expect(await controller.close("editor:a")).toBe(true);
209
- });
210
-
211
- it("asks before closing a dirty document", async () => {
212
- let { controller, fake, confirmClose } = setup();
213
- await controller.initialize();
214
- let onSave = vi.fn().mockResolvedValue(false);
215
- controller.registerGuards("editor:a", { onSave });
216
- controller.setDirty("editor:a", true);
217
-
218
- confirmClose.mockResolvedValueOnce("cancel");
219
- expect(await controller.close("editor:a")).toBe(false);
220
-
221
- confirmClose.mockResolvedValueOnce("save");
222
- expect(await controller.close("editor:a")).toBe(false);
223
- expect(onSave).toHaveBeenCalledTimes(1);
224
- expect(fake.panels.has("editor:a")).toBe(true);
225
-
226
- onSave.mockResolvedValue(true);
227
- confirmClose.mockResolvedValueOnce("save");
228
- expect(await controller.close("editor:a")).toBe(true);
229
- expect(fake.panels.has("editor:a")).toBe(false);
230
-
231
- controller.setDirty("editor:b", true);
232
- confirmClose.mockResolvedValueOnce("discard");
233
- expect(await controller.close("editor:b")).toBe(true);
234
- expect(confirmClose).toHaveBeenCalledTimes(4);
235
- });
236
-
237
- it("closes by key without prompting", async () => {
238
- let { controller, fake, confirmClose } = setup();
239
- await controller.initialize();
240
- controller.setDirty("editor:a", true);
241
-
242
- await controller.closeByKey("a");
243
-
244
- expect(confirmClose).not.toHaveBeenCalled();
245
- expect(fake.panels.has("editor:a")).toBe(false);
246
- });
247
-
248
- it("closes all closable documents of a type and stops at a veto", async () => {
249
- let { controller, fake } = setup();
250
- await controller.initialize();
251
- controller.openDocument({ type: "settings" });
252
-
253
- expect(await controller.closeAll("editor")).toBe(true);
254
- expect([...fake.panels.keys()]).toEqual(["explorer", "properties", "settings"]);
255
-
256
- controller.openDocument({ type: "editor", key: "x" });
257
- controller.openDocument({ type: "editor", key: "y" });
258
- controller.registerGuards("editor:x", { onClosing: () => false });
259
-
260
- expect(await controller.closeAll()).toBe(false);
261
- expect(fake.panels.has("editor:x")).toBe(true);
262
- expect(fake.panels.has("explorer")).toBe(true);
263
- });
264
-
265
- it("treats a panel removed by dockview as closed", async () => {
266
- let { controller, fake } = setup();
267
- await controller.initialize();
268
-
269
- fake.host.getPanel("editor:b")!.close();
270
-
271
- expect(controller.getDocument("editor:b")).toBeUndefined();
272
- });
273
- });
274
-
275
- describe("state", () => {
276
- it("tracks titles, dirty flags and the active document", async () => {
277
- let { controller, fake } = setup();
278
- await controller.initialize();
279
- let events: string[] = [];
280
- controller.subscribe("titleChange", (event) => events.push(`title:${event.id}:${event.title}`));
281
- controller.subscribe("dirtyChange", (event) => events.push(`dirty:${event.id}:${event.dirty}`));
282
- controller.subscribe("activeChange", (event) => events.push(`active:${event?.id}`));
283
-
284
- controller.setTitle("editor:a", "Renamed");
285
- controller.setDirty("editor:a", true);
286
- fake.activate("editor:a");
287
-
288
- expect(fake.panels.get("editor:a")?.title).toBe("Renamed");
289
- expect(controller.getDocument("editor:a")).toMatchObject({ title: "Renamed", dirty: true, isActive: true });
290
- expect(controller.hasDirty()).toBe(true);
291
- expect(events).toEqual(["title:editor:a:Renamed", "dirty:editor:a:true", "active:editor:a"]);
292
- });
293
-
294
- it("keeps snapshots stable until something changes", async () => {
295
- let { controller } = setup();
296
- await controller.initialize();
297
-
298
- let first = controller.getDocumentsSnapshot();
299
- expect(controller.getDocumentsSnapshot()).toBe(first);
300
- expect(controller.getDocument("editor:a")).toBe(controller.getDocument("editor:a"));
301
-
302
- controller.setTitle("editor:a", "x");
303
-
304
- expect(controller.getDocumentsSnapshot()).not.toBe(first);
305
- });
306
-
307
- it("pops a document out through the host", async () => {
308
- let { controller, fake } = setup();
309
- await controller.initialize();
310
-
311
- expect(await controller.popout("editor:a")).toBe(true);
312
- expect(fake.popouts).toEqual([{ id: "editor:a", popoutUrl: "/popout" }]);
313
- expect(await controller.popout("nope")).toBe(false);
314
- });
315
- });
316
-
317
- describe("persistence", () => {
318
- it("saves layout changes when persistence is on", async () => {
319
- vi.useFakeTimers();
320
- let settings = createMemorySettingsStore();
321
- let store = createLayoutStore(settings, "art");
322
- let { controller, fake } = setup({ id: "dock", persist: true }, testTypes, store);
323
-
324
- await controller.initialize();
325
- expect(settings.data.has("art.dock")).toBe(false);
326
-
327
- controller.openDocument({ type: "editor", key: "z" });
328
- fake.fireLayout();
329
- await vi.advanceTimersByTimeAsync(300);
330
-
331
- let saved = settings.data.get("art.dock") as MdiLayout;
332
- expect(saved.format).toBe(1);
333
- expect(Object.keys(saved.documents)).toContain("editor:z");
334
- expect(saved.dockview.panels["editor:z"]).toBeDefined();
335
- vi.useRealTimers();
336
- });
337
-
338
- it("does not touch the store without an id", async () => {
339
- let settings = createMemorySettingsStore();
340
- let { controller, fake } = setup({ persist: true }, testTypes, createLayoutStore(settings, "art"));
341
-
342
- await controller.initialize();
343
- fake.fireLayout();
344
- await controller.saveLayout();
345
-
346
- expect(settings.data.size).toBe(0);
347
- });
348
-
349
- it("saves, loads and resets on demand without auto-save", async () => {
350
- let settings = createMemorySettingsStore();
351
- let store = createLayoutStore(settings, "art");
352
- let { controller, fake } = setup({ id: "dock", persist: false }, testTypes, store);
353
- await controller.initialize();
354
-
355
- controller.openDocument({ type: "settings" });
356
- let saved = await controller.saveLayout();
357
- expect(settings.data.get("art.dock")).toBe(saved);
358
-
359
- await controller.close("settings", { force: true });
360
- expect(fake.panels.has("settings")).toBe(false);
361
-
362
- await controller.loadLayout();
363
- expect(fake.panels.has("settings")).toBe(true);
364
-
365
- await controller.resetLayout();
366
- expect(fake.panels.has("settings")).toBe(false);
367
- expect(settings.data.has("art.dock")).toBe(false);
368
- expect(fake.panels.size).toBe(4);
369
- });
370
- });
371
-
372
- it("stops acting on the host after detach", async () => {
373
- let { controller, fake } = setup();
374
- await controller.initialize();
375
-
376
- controller.detach();
377
- fake.activate("editor:a");
378
-
379
- expect(controller.getActive()?.id).toBe("explorer");
380
- expect(() => controller.openDocument({ type: "settings" })).toThrow(/no dock is mounted/);
381
- });
382
- });
1
+ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
2
+
3
+ import { MdiController, type MdiControllerOptions } from "./controller.js";
4
+ import { createFakeHost } from "./fakeHost.js";
5
+ import { layoutSpecToLayout } from "./layoutSpec.js";
6
+ import { createLayoutStore, type MdiLayoutStore } from "./layoutStore.js";
7
+ import { createMemorySettingsStore } from "./memorySettingsStore.js";
8
+ import { testSpec, testTypes } from "./testTypes.js";
9
+ import type { MdiConfirmCloseResult, MdiDocumentTypes, MdiLayout, MdiLayoutSpec } from "./types.js";
10
+
11
+ function setup(
12
+ options: Partial<MdiControllerOptions> = {},
13
+ types: MdiDocumentTypes = testTypes,
14
+ store?: MdiLayoutStore,
15
+ ) {
16
+ let fake = createFakeHost();
17
+ let confirmClose = vi.fn<(document: unknown) => Promise<MdiConfirmCloseResult>>().mockResolvedValue("discard");
18
+ let controller = new MdiController(types, store ?? createLayoutStore(createMemorySettingsStore(), "art"));
19
+
20
+ controller.setOptions({
21
+ layoutVersion: 1,
22
+ defaultLayout: testSpec,
23
+ persist: false,
24
+ popoutUrl: "/popout",
25
+ confirmClose,
26
+ ...options,
27
+ });
28
+ controller.attach(fake.host);
29
+
30
+ return { controller, fake, confirmClose };
31
+ }
32
+
33
+ describe("MdiController", () => {
34
+ beforeEach(() => {
35
+ vi.spyOn(console, "warn").mockImplementation(() => {});
36
+ });
37
+
38
+ afterEach(() => {
39
+ vi.restoreAllMocks();
40
+ });
41
+
42
+ describe("initialize", () => {
43
+ it("applies the default layout", async () => {
44
+ let { controller, fake } = setup();
45
+
46
+ await controller.initialize();
47
+
48
+ expect([...fake.panels.keys()]).toEqual(["explorer", "editor:a", "editor:b", "properties"]);
49
+ expect(controller.getDocuments().map((document) => document.id)).toEqual([
50
+ "explorer",
51
+ "editor:a",
52
+ "editor:b",
53
+ "properties",
54
+ ]);
55
+ expect(controller.getActive()?.id).toBe("explorer");
56
+ expect(fake.groups.get("mdi-g1")).toMatchObject({ locked: true, headerHidden: true });
57
+ });
58
+
59
+ it("restores no-drop-target groups after dockview reduced the flag to a boolean", async () => {
60
+ let spec: MdiLayoutSpec = {
61
+ root: {
62
+ direction: "horizontal",
63
+ children: [
64
+ { tabs: [{ type: "explorer" }], locked: "no-drop-target" },
65
+ { tabs: [{ type: "properties" }], locked: true },
66
+ ],
67
+ },
68
+ };
69
+ let { controller, fake } = setup({ defaultLayout: spec });
70
+
71
+ await controller.initialize();
72
+
73
+ expect(fake.groups.get("mdi-g1")?.locked).toBe("no-drop-target");
74
+ expect(fake.groups.get("mdi-g2")?.locked).toBe(true);
75
+ });
76
+
77
+ it("restores a persisted layout and drops documents the resolver rejects", async () => {
78
+ let restore = vi.fn(async ({ key }: { key?: string }) => (key === "b" ? false : { title: `Restored ${key}` }));
79
+ let types: MdiDocumentTypes = { ...testTypes, editor: { ...testTypes["editor"]!, restore } };
80
+ let persisted = layoutSpecToLayout(testSpec, types, 1);
81
+ let store = createLayoutStore(createMemorySettingsStore({ "art.dock": persisted }), "art");
82
+ let { controller, fake } = setup({ id: "dock", persist: true }, types, store);
83
+
84
+ await controller.initialize();
85
+
86
+ expect(restore).toHaveBeenCalledTimes(2);
87
+ expect([...fake.panels.keys()]).toEqual(["explorer", "editor:a", "properties"]);
88
+ expect(controller.getDocument("editor:a")?.title).toBe("Restored a");
89
+ expect(fake.panels.get("editor:a")?.title).toBe("Restored a");
90
+ });
91
+
92
+ it("falls back to the default layout when the version differs", async () => {
93
+ let persisted = { ...layoutSpecToLayout(testSpec, testTypes, 1), layoutVersion: 0 };
94
+ let store = createLayoutStore(createMemorySettingsStore({ "art.dock": persisted }), "art");
95
+ let { controller, fake } = setup({ id: "dock", persist: true }, testTypes, store);
96
+
97
+ await controller.initialize();
98
+
99
+ expect(fake.panels.size).toBe(4);
100
+ });
101
+
102
+ it("re-adds fixed panes that are missing from a saved layout", async () => {
103
+ let persisted = layoutSpecToLayout(testSpec, testTypes, 1);
104
+ delete persisted.documents["properties"];
105
+ delete persisted.dockview.panels["properties"];
106
+ let store = createLayoutStore(createMemorySettingsStore({ "art.dock": persisted }), "art");
107
+ let { controller, fake } = setup({ id: "dock", persist: true }, testTypes, store);
108
+
109
+ await controller.initialize();
110
+
111
+ expect(fake.panels.has("properties")).toBe(true);
112
+ expect(controller.getDocument("properties")).toMatchObject({ closable: false, isActive: false });
113
+ });
114
+
115
+ it("drops documents whose type is no longer registered", async () => {
116
+ let persisted = layoutSpecToLayout(testSpec, testTypes, 1);
117
+ let { settings: _settings, ...types } = testTypes;
118
+ persisted.documents["ghost"] = { type: "ghost", params: {}, closable: true };
119
+ persisted.dockview.panels["ghost"] = { id: "ghost", contentComponent: "mdi" };
120
+ let store = createLayoutStore(createMemorySettingsStore({ "art.dock": persisted }), "art");
121
+ let { controller, fake } = setup({ id: "dock", persist: true }, types, store);
122
+
123
+ await controller.initialize();
124
+
125
+ expect(fake.panels.has("ghost")).toBe(false);
126
+ expect(controller.getDocument("ghost")).toBeUndefined();
127
+ });
128
+ });
129
+
130
+ describe("opening", () => {
131
+ it("opens a keyed document once and activates it on the second call", async () => {
132
+ let { controller, fake } = setup();
133
+ await controller.initialize();
134
+ let opened = vi.fn();
135
+ controller.subscribe("open", opened);
136
+
137
+ let id = controller.openDocument({ type: "editor", key: "c", params: { name: "C" } });
138
+ fake.activate("explorer");
139
+ let again = controller.openDocument({ type: "editor", key: "c", params: { name: "C2" } });
140
+
141
+ expect(id).toBe("editor:c");
142
+ expect(again).toBe(id);
143
+ expect(opened).toHaveBeenCalledTimes(1);
144
+ expect(fake.panels.size).toBe(5);
145
+ expect(controller.getDocument(id)?.params).toEqual({ name: "C2" });
146
+ expect(controller.getActive()?.id).toBe(id);
147
+ });
148
+
149
+ it("ignores the key of singleton types", async () => {
150
+ let { controller } = setup();
151
+ await controller.initialize();
152
+
153
+ expect(controller.openDocument({ type: "settings", key: "whatever" })).toBe("settings");
154
+ expect(controller.panelId("settings", "x")).toBe("settings");
155
+ expect(controller.panelId("editor", "x")).toBe("editor:x");
156
+ });
157
+
158
+ it("adds new documents to the active group by default", async () => {
159
+ let { controller, fake } = setup();
160
+ await controller.initialize();
161
+ fake.activate("editor:a");
162
+
163
+ controller.openDocument({ type: "editor", key: "d" });
164
+
165
+ expect(fake.panels.get("editor:d")?.groupId).toBe(fake.panels.get("editor:a")?.groupId);
166
+ });
167
+
168
+ it("rejects unknown types", async () => {
169
+ let { controller } = setup();
170
+ await controller.initialize();
171
+
172
+ expect(() => controller.openDocument({ type: "nope" })).toThrow(/unknown document type/);
173
+ });
174
+ });
175
+
176
+ describe("closing", () => {
177
+ it("refuses to close unclosable documents unless forced", async () => {
178
+ let { controller, fake } = setup();
179
+ await controller.initialize();
180
+
181
+ expect(await controller.close("explorer")).toBe(false);
182
+ expect(fake.panels.has("explorer")).toBe(true);
183
+ expect(await controller.close("explorer", { force: true })).toBe(true);
184
+ expect(fake.panels.has("explorer")).toBe(false);
185
+ });
186
+
187
+ it("closes a clean document and reports it", async () => {
188
+ let { controller, fake } = setup();
189
+ await controller.initialize();
190
+ let closed = vi.fn();
191
+ controller.subscribe("close", closed);
192
+
193
+ expect(await controller.close("editor:a")).toBe(true);
194
+ expect(fake.panels.has("editor:a")).toBe(false);
195
+ expect(controller.getDocument("editor:a")).toBeUndefined();
196
+ expect(closed).toHaveBeenCalledWith(expect.objectContaining({ id: "editor:a" }));
197
+ });
198
+
199
+ it("lets an onClosing guard veto", async () => {
200
+ let { controller, fake } = setup();
201
+ await controller.initialize();
202
+ let unregister = controller.registerGuards("editor:a", { onClosing: () => false });
203
+
204
+ expect(await controller.close("editor:a")).toBe(false);
205
+ expect(fake.panels.has("editor:a")).toBe(true);
206
+
207
+ unregister();
208
+ expect(await controller.close("editor:a")).toBe(true);
209
+ });
210
+
211
+ it("asks before closing a dirty document", async () => {
212
+ let { controller, fake, confirmClose } = setup();
213
+ await controller.initialize();
214
+ let onSave = vi.fn().mockResolvedValue(false);
215
+ controller.registerGuards("editor:a", { onSave });
216
+ controller.setDirty("editor:a", true);
217
+
218
+ confirmClose.mockResolvedValueOnce("cancel");
219
+ expect(await controller.close("editor:a")).toBe(false);
220
+
221
+ confirmClose.mockResolvedValueOnce("save");
222
+ expect(await controller.close("editor:a")).toBe(false);
223
+ expect(onSave).toHaveBeenCalledTimes(1);
224
+ expect(fake.panels.has("editor:a")).toBe(true);
225
+
226
+ onSave.mockResolvedValue(true);
227
+ confirmClose.mockResolvedValueOnce("save");
228
+ expect(await controller.close("editor:a")).toBe(true);
229
+ expect(fake.panels.has("editor:a")).toBe(false);
230
+
231
+ controller.setDirty("editor:b", true);
232
+ confirmClose.mockResolvedValueOnce("discard");
233
+ expect(await controller.close("editor:b")).toBe(true);
234
+ expect(confirmClose).toHaveBeenCalledTimes(4);
235
+ });
236
+
237
+ it("closes by key without prompting", async () => {
238
+ let { controller, fake, confirmClose } = setup();
239
+ await controller.initialize();
240
+ controller.setDirty("editor:a", true);
241
+
242
+ await controller.closeByKey("a");
243
+
244
+ expect(confirmClose).not.toHaveBeenCalled();
245
+ expect(fake.panels.has("editor:a")).toBe(false);
246
+ });
247
+
248
+ it("closes all closable documents of a type and stops at a veto", async () => {
249
+ let { controller, fake } = setup();
250
+ await controller.initialize();
251
+ controller.openDocument({ type: "settings" });
252
+
253
+ expect(await controller.closeAll("editor")).toBe(true);
254
+ expect([...fake.panels.keys()]).toEqual(["explorer", "properties", "settings"]);
255
+
256
+ controller.openDocument({ type: "editor", key: "x" });
257
+ controller.openDocument({ type: "editor", key: "y" });
258
+ controller.registerGuards("editor:x", { onClosing: () => false });
259
+
260
+ expect(await controller.closeAll()).toBe(false);
261
+ expect(fake.panels.has("editor:x")).toBe(true);
262
+ expect(fake.panels.has("explorer")).toBe(true);
263
+ });
264
+
265
+ it("treats a panel removed by dockview as closed", async () => {
266
+ let { controller, fake } = setup();
267
+ await controller.initialize();
268
+
269
+ fake.host.getPanel("editor:b")!.close();
270
+
271
+ expect(controller.getDocument("editor:b")).toBeUndefined();
272
+ });
273
+ });
274
+
275
+ describe("state", () => {
276
+ it("tracks titles, dirty flags and the active document", async () => {
277
+ let { controller, fake } = setup();
278
+ await controller.initialize();
279
+ let events: string[] = [];
280
+ controller.subscribe("titleChange", (event) => events.push(`title:${event.id}:${event.title}`));
281
+ controller.subscribe("dirtyChange", (event) => events.push(`dirty:${event.id}:${event.dirty}`));
282
+ controller.subscribe("activeChange", (event) => events.push(`active:${event?.id}`));
283
+
284
+ controller.setTitle("editor:a", "Renamed");
285
+ controller.setDirty("editor:a", true);
286
+ fake.activate("editor:a");
287
+
288
+ expect(fake.panels.get("editor:a")?.title).toBe("Renamed");
289
+ expect(controller.getDocument("editor:a")).toMatchObject({ title: "Renamed", dirty: true, isActive: true });
290
+ expect(controller.hasDirty()).toBe(true);
291
+ expect(events).toEqual(["title:editor:a:Renamed", "dirty:editor:a:true", "active:editor:a"]);
292
+ });
293
+
294
+ it("keeps snapshots stable until something changes", async () => {
295
+ let { controller } = setup();
296
+ await controller.initialize();
297
+
298
+ let first = controller.getDocumentsSnapshot();
299
+ expect(controller.getDocumentsSnapshot()).toBe(first);
300
+ expect(controller.getDocument("editor:a")).toBe(controller.getDocument("editor:a"));
301
+
302
+ controller.setTitle("editor:a", "x");
303
+
304
+ expect(controller.getDocumentsSnapshot()).not.toBe(first);
305
+ });
306
+
307
+ it("pops a document out through the host", async () => {
308
+ let { controller, fake } = setup();
309
+ await controller.initialize();
310
+
311
+ expect(await controller.popout("editor:a")).toBe(true);
312
+ expect(fake.popouts).toEqual([{ id: "editor:a", popoutUrl: "/popout" }]);
313
+ expect(await controller.popout("nope")).toBe(false);
314
+ });
315
+ });
316
+
317
+ describe("persistence", () => {
318
+ it("saves layout changes when persistence is on", async () => {
319
+ vi.useFakeTimers();
320
+ let settings = createMemorySettingsStore();
321
+ let store = createLayoutStore(settings, "art");
322
+ let { controller, fake } = setup({ id: "dock", persist: true }, testTypes, store);
323
+
324
+ await controller.initialize();
325
+ expect(settings.data.has("art.dock")).toBe(false);
326
+
327
+ controller.openDocument({ type: "editor", key: "z" });
328
+ fake.fireLayout();
329
+ await vi.advanceTimersByTimeAsync(300);
330
+
331
+ let saved = settings.data.get("art.dock") as MdiLayout;
332
+ expect(saved.format).toBe(1);
333
+ expect(Object.keys(saved.documents)).toContain("editor:z");
334
+ expect(saved.dockview.panels["editor:z"]).toBeDefined();
335
+ vi.useRealTimers();
336
+ });
337
+
338
+ it("does not touch the store without an id", async () => {
339
+ let settings = createMemorySettingsStore();
340
+ let { controller, fake } = setup({ persist: true }, testTypes, createLayoutStore(settings, "art"));
341
+
342
+ await controller.initialize();
343
+ fake.fireLayout();
344
+ await controller.saveLayout();
345
+
346
+ expect(settings.data.size).toBe(0);
347
+ });
348
+
349
+ it("saves, loads and resets on demand without auto-save", async () => {
350
+ let settings = createMemorySettingsStore();
351
+ let store = createLayoutStore(settings, "art");
352
+ let { controller, fake } = setup({ id: "dock", persist: false }, testTypes, store);
353
+ await controller.initialize();
354
+
355
+ controller.openDocument({ type: "settings" });
356
+ let saved = await controller.saveLayout();
357
+ expect(settings.data.get("art.dock")).toBe(saved);
358
+
359
+ await controller.close("settings", { force: true });
360
+ expect(fake.panels.has("settings")).toBe(false);
361
+
362
+ await controller.loadLayout();
363
+ expect(fake.panels.has("settings")).toBe(true);
364
+
365
+ await controller.resetLayout();
366
+ expect(fake.panels.has("settings")).toBe(false);
367
+ expect(settings.data.has("art.dock")).toBe(false);
368
+ expect(fake.panels.size).toBe(4);
369
+ });
370
+ });
371
+
372
+ it("stops acting on the host after detach", async () => {
373
+ let { controller, fake } = setup();
374
+ await controller.initialize();
375
+
376
+ controller.detach();
377
+ fake.activate("editor:a");
378
+
379
+ expect(controller.getActive()?.id).toBe("explorer");
380
+ expect(() => controller.openDocument({ type: "settings" })).toThrow(/no dock is mounted/);
381
+ });
382
+ });