@mapomodule/form 2.0.0-beta.9 → 2.0.0-experimental.2

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 (145) hide show
  1. package/README.md +38 -119
  2. package/dist/index.d.mts +2 -1
  3. package/dist/index.d.ts +3 -1
  4. package/dist/index.d.ts.map +1 -1
  5. package/dist/index.mjs +1 -0
  6. package/dist/module.d.mts +1 -0
  7. package/dist/module.d.ts.map +1 -1
  8. package/dist/module.json +1 -1
  9. package/dist/module.mjs +9 -0
  10. package/dist/runtime/components/MapoFocusPortal.vue +9 -2
  11. package/dist/runtime/components/MapoFocusPortal.vue.d.ts.map +1 -1
  12. package/dist/runtime/components/MapoForm.vue +28 -6
  13. package/dist/runtime/components/MapoForm.vue.d.ts +13 -1
  14. package/dist/runtime/components/MapoForm.vue.d.ts.map +1 -1
  15. package/dist/runtime/components/MapoFormAnnotation.vue +79 -0
  16. package/dist/runtime/components/MapoFormAnnotation.vue.d.ts +27 -0
  17. package/dist/runtime/components/MapoFormAnnotation.vue.d.ts.map +1 -0
  18. package/dist/runtime/components/MapoFormAnnotationBadges.vue +28 -0
  19. package/dist/runtime/components/MapoFormAnnotationBadges.vue.d.ts +13 -0
  20. package/dist/runtime/components/MapoFormAnnotationBadges.vue.d.ts.map +1 -0
  21. package/dist/runtime/components/MapoFormField.vue +47 -11
  22. package/dist/runtime/components/MapoFormField.vue.d.ts +15 -9
  23. package/dist/runtime/components/MapoFormField.vue.d.ts.map +1 -1
  24. package/dist/runtime/components/MapoFormGroup.vue +18 -2
  25. package/dist/runtime/components/MapoFormGroup.vue.d.ts.map +1 -1
  26. package/dist/runtime/components/MapoFormTabs.vue +50 -8
  27. package/dist/runtime/components/MapoFormTabs.vue.d.ts.map +1 -1
  28. package/dist/runtime/components/fields/MapoMediaField.vue +5 -3
  29. package/dist/runtime/components/fields/MapoMediaField.vue.d.ts.map +1 -1
  30. package/dist/runtime/components/fields/MapoMediaM2mField.vue +3 -2
  31. package/dist/runtime/components/fields/MapoMediaM2mField.vue.d.ts.map +1 -1
  32. package/dist/runtime/components/fields/MapoRepeater.vue +73 -14
  33. package/dist/runtime/components/fields/MapoRepeater.vue.d.ts.map +1 -1
  34. package/dist/runtime/components/fields/MapoRepeaterBlockPicker.vue +167 -0
  35. package/dist/runtime/components/fields/MapoRepeaterBlockPicker.vue.d.ts +20 -0
  36. package/dist/runtime/components/fields/MapoRepeaterBlockPicker.vue.d.ts.map +1 -0
  37. package/dist/runtime/components/fields/MapoRepeaterItem.vue +46 -10
  38. package/dist/runtime/components/fields/MapoRepeaterItem.vue.d.ts +6 -2
  39. package/dist/runtime/components/fields/MapoRepeaterItem.vue.d.ts.map +1 -1
  40. package/dist/runtime/components/fields/MapoWygEditor.vue +19 -13
  41. package/dist/runtime/components/fields/MapoWygEditor.vue.d.ts.map +1 -1
  42. package/dist/runtime/composables/useFieldAnnotation.d.ts +18 -0
  43. package/dist/runtime/composables/useFieldAnnotation.d.ts.map +1 -0
  44. package/dist/runtime/composables/useFieldAnnotation.js +16 -0
  45. package/dist/runtime/composables/useFocusMode.d.ts +3 -1
  46. package/dist/runtime/composables/useFocusMode.d.ts.map +1 -1
  47. package/dist/runtime/composables/useFormFromSchema.d.ts +23 -1
  48. package/dist/runtime/composables/useFormFromSchema.d.ts.map +1 -1
  49. package/dist/runtime/composables/useFormFromSchema.js +171 -32
  50. package/dist/runtime/composables/useMapoForm.d.ts +21 -3
  51. package/dist/runtime/composables/useMapoForm.d.ts.map +1 -1
  52. package/dist/runtime/composables/useMapoForm.js +49 -15
  53. package/dist/runtime/types/annotation.d.ts +43 -0
  54. package/dist/runtime/types/annotation.d.ts.map +1 -0
  55. package/dist/runtime/types/annotation.js +0 -0
  56. package/dist/runtime/types/descriptor.d.ts +81 -4
  57. package/dist/runtime/types/descriptor.d.ts.map +1 -1
  58. package/dist/runtime/types/index.d.ts +2 -1
  59. package/dist/runtime/types/index.d.ts.map +1 -1
  60. package/dist/runtime/utils/annotations.d.ts +40 -0
  61. package/dist/runtime/utils/annotations.d.ts.map +1 -0
  62. package/dist/runtime/utils/annotations.js +78 -0
  63. package/dist/runtime/utils/draft.d.ts +21 -0
  64. package/dist/runtime/utils/draft.d.ts.map +1 -0
  65. package/dist/runtime/utils/draft.js +108 -0
  66. package/dist/runtime/utils/fieldComponent.d.ts +9 -0
  67. package/dist/runtime/utils/fieldComponent.d.ts.map +1 -0
  68. package/dist/runtime/utils/fieldComponent.js +12 -0
  69. package/dist/runtime/utils/fieldFocus.d.ts +24 -0
  70. package/dist/runtime/utils/fieldFocus.d.ts.map +1 -0
  71. package/dist/runtime/utils/fieldFocus.js +41 -0
  72. package/dist/runtime/utils/fieldsToJsonSchema.d.ts +38 -0
  73. package/dist/runtime/utils/fieldsToJsonSchema.d.ts.map +1 -0
  74. package/dist/runtime/utils/fieldsToJsonSchema.js +248 -0
  75. package/dist/runtime/utils/repeaterTemplates.d.ts +26 -0
  76. package/dist/runtime/utils/repeaterTemplates.d.ts.map +1 -0
  77. package/dist/runtime/utils/repeaterTemplates.js +51 -0
  78. package/dist/runtime/utils/reveal.d.ts +34 -0
  79. package/dist/runtime/utils/reveal.d.ts.map +1 -0
  80. package/dist/runtime/utils/reveal.js +29 -0
  81. package/dist/runtime/utils/tabVisibility.d.ts +18 -0
  82. package/dist/runtime/utils/tabVisibility.d.ts.map +1 -0
  83. package/dist/runtime/utils/tabVisibility.js +18 -0
  84. package/package.json +5 -5
  85. package/src/__tests__/MapoFocusPortal.component.test.ts +97 -0
  86. package/src/__tests__/MapoForm.component.test.ts +79 -0
  87. package/src/__tests__/MapoFormAnnotation.component.test.ts +244 -0
  88. package/src/__tests__/MapoFormField.component.test.ts +508 -0
  89. package/src/__tests__/MapoFormGroup.component.test.ts +141 -0
  90. package/src/__tests__/MapoFormTabs.component.test.ts +254 -0
  91. package/src/__tests__/MapoRepeaterItem.component.test.ts +286 -0
  92. package/src/__tests__/MapoWygEditor.component.test.ts +95 -0
  93. package/src/__tests__/annotations.test.ts +227 -0
  94. package/src/__tests__/draft.test.ts +221 -0
  95. package/src/__tests__/fieldComponent.test.ts +31 -0
  96. package/src/__tests__/fieldExtensions.test.ts +63 -0
  97. package/src/__tests__/fieldFocus.test.ts +178 -0
  98. package/src/__tests__/fieldsToJsonSchema.test.ts +630 -0
  99. package/src/__tests__/headlessRenderer.ts +85 -0
  100. package/src/__tests__/repeaterTemplates.test.ts +154 -0
  101. package/src/__tests__/reveal.test.ts +89 -0
  102. package/src/__tests__/schemaSources.test.ts +132 -0
  103. package/src/__tests__/tabVisibility.test.ts +102 -0
  104. package/src/__tests__/useFormFromSchema.test.ts +387 -0
  105. package/src/__tests__/useMapoForm.test.ts +213 -2
  106. package/src/index.ts +9 -0
  107. package/src/module.ts +9 -0
  108. package/src/runtime/components/MapoFocusPortal.vue +15 -2
  109. package/src/runtime/components/MapoForm.vue +47 -4
  110. package/src/runtime/components/MapoFormAnnotation.vue +113 -0
  111. package/src/runtime/components/MapoFormAnnotationBadges.vue +41 -0
  112. package/src/runtime/components/MapoFormField.vue +72 -11
  113. package/src/runtime/components/MapoFormGroup.vue +20 -2
  114. package/src/runtime/components/MapoFormTabs.vue +64 -8
  115. package/src/runtime/components/fields/MapoMediaField.vue +5 -3
  116. package/src/runtime/components/fields/MapoMediaM2mField.vue +3 -2
  117. package/src/runtime/components/fields/MapoRepeater.vue +82 -14
  118. package/src/runtime/components/fields/MapoRepeaterBlockPicker.vue +188 -0
  119. package/src/runtime/components/fields/MapoRepeaterItem.vue +56 -8
  120. package/src/runtime/components/fields/MapoWygEditor.vue +22 -14
  121. package/src/runtime/composables/useFieldAnnotation.ts +38 -0
  122. package/src/runtime/composables/useFocusMode.ts +7 -1
  123. package/src/runtime/composables/useFormFromSchema.ts +303 -41
  124. package/src/runtime/composables/useMapoForm.ts +103 -23
  125. package/src/runtime/types/annotation.ts +53 -0
  126. package/src/runtime/types/descriptor.ts +94 -4
  127. package/src/runtime/types/index.ts +10 -0
  128. package/src/runtime/utils/annotations.ts +169 -0
  129. package/src/runtime/utils/draft.ts +158 -0
  130. package/src/runtime/utils/fieldComponent.ts +34 -0
  131. package/src/runtime/utils/fieldFocus.ts +73 -0
  132. package/src/runtime/utils/fieldsToJsonSchema.ts +405 -0
  133. package/src/runtime/utils/repeaterTemplates.ts +103 -0
  134. package/src/runtime/utils/reveal.ts +68 -0
  135. package/src/runtime/utils/tabVisibility.ts +44 -0
  136. package/dist/__tests__/__mocks__/nuxt-imports.d.ts +0 -4
  137. package/dist/__tests__/__mocks__/nuxt-imports.d.ts.map +0 -1
  138. package/dist/__tests__/camomillaRoundTrip.test.d.ts +0 -2
  139. package/dist/__tests__/camomillaRoundTrip.test.d.ts.map +0 -1
  140. package/dist/__tests__/registry.test.d.ts +0 -2
  141. package/dist/__tests__/registry.test.d.ts.map +0 -1
  142. package/dist/__tests__/useFormFromSchema.test.d.ts +0 -2
  143. package/dist/__tests__/useFormFromSchema.test.d.ts.map +0 -1
  144. package/dist/__tests__/useMapoForm.test.d.ts +0 -2
  145. package/dist/__tests__/useMapoForm.test.d.ts.map +0 -1
@@ -0,0 +1,178 @@
1
+ import { afterEach, describe, expect, it, vi } from "vitest";
2
+
3
+ import { focusFieldControl, refocusField } from "../runtime/utils/fieldFocus";
4
+
5
+ /** An element as `refocusField()` reads it: what it matches, what it holds, `focus()`. */
6
+ interface FakeElement {
7
+ matches(selector: string): boolean;
8
+ querySelector(selector: string): FakeElement | null;
9
+ focus: ReturnType<typeof vi.fn>;
10
+ }
11
+
12
+ function element(focusable: boolean, inside: FakeElement | null = null) {
13
+ const made: FakeElement = {
14
+ matches: () => focusable,
15
+ querySelector: () => inside,
16
+ focus: vi.fn(),
17
+ };
18
+ return made;
19
+ }
20
+
21
+ const body = element(false);
22
+
23
+ /** A page whose focus is on `active`, with the elements of `byId`. */
24
+ function page(active: FakeElement | null, byId: Record<string, FakeElement>) {
25
+ vi.stubGlobal("document", {
26
+ body,
27
+ activeElement: active,
28
+ getElementById: (id: string) => byId[id] ?? null,
29
+ });
30
+ }
31
+
32
+ afterEach(() => {
33
+ vi.unstubAllGlobals();
34
+ });
35
+
36
+ describe("refocusField", () => {
37
+ it("focuses the field's control when the focus fell on the page", () => {
38
+ const input = element(true);
39
+ page(body, { "field-title": input });
40
+
41
+ expect(refocusField("field-title")).toBe(true);
42
+ expect(input.focus).toHaveBeenCalledTimes(1);
43
+ });
44
+
45
+ it("focuses what takes the focus inside the field, as an editor's content", () => {
46
+ const content = element(true);
47
+ const editor = element(false, content);
48
+ page(null, { "field-body": editor });
49
+
50
+ expect(refocusField("field-body")).toBe(true);
51
+ expect(content.focus).toHaveBeenCalledTimes(1);
52
+ expect(editor.focus).not.toHaveBeenCalled();
53
+ });
54
+
55
+ it("leaves a focus held elsewhere where it is, as by a dialog", () => {
56
+ const input = element(true);
57
+ const dialog = element(true);
58
+ page(dialog, { "field-title": input });
59
+
60
+ expect(refocusField("field-title")).toBe(false);
61
+ expect(input.focus).not.toHaveBeenCalled();
62
+ });
63
+
64
+ it("does nothing for a field it cannot find, or one with nothing to focus", () => {
65
+ page(body, { "field-plain": element(false) });
66
+
67
+ expect(refocusField("field-missing")).toBe(false);
68
+ expect(refocusField("field-plain")).toBe(false);
69
+ });
70
+
71
+ it("does nothing on the server", () => {
72
+ expect(typeof document).toBe("undefined");
73
+ expect(refocusField("field-title")).toBe(false);
74
+ });
75
+ });
76
+
77
+ /** The page of {@link focusFieldControl}: what has the focus. */
78
+ interface FakeDocument {
79
+ activeElement: unknown;
80
+ }
81
+
82
+ /** A field's control: whether it takes the focus, and the focusable inside it. */
83
+ function control(doc: FakeDocument, focusable: boolean, inside?: unknown) {
84
+ const made = {
85
+ matches: () => focusable,
86
+ querySelector: () => inside ?? null,
87
+ focus: vi.fn(() => {
88
+ doc.activeElement = made;
89
+ }),
90
+ };
91
+ return made;
92
+ }
93
+
94
+ /** A field's element, holding `byId` and scrolled with `scrollIntoView`. */
95
+ function fieldElement(doc: FakeDocument, byId: Record<string, unknown>) {
96
+ return {
97
+ ownerDocument: doc,
98
+ querySelector: vi.fn((selector: string) => {
99
+ const id = /^\[id="(.*)"\]$/.exec(selector)?.[1] ?? "";
100
+ return byId[id] ?? null;
101
+ }),
102
+ scrollIntoView: vi.fn(),
103
+ };
104
+ }
105
+
106
+ describe("focusFieldControl", () => {
107
+ it("focuses the control with the field's id inside the field, and scrolls the field to the middle", () => {
108
+ const doc: FakeDocument = { activeElement: null };
109
+ const input = control(doc, true);
110
+ const field = fieldElement(doc, { "field-title": input });
111
+
112
+ expect(focusFieldControl(field, "field-title")).toBe(true);
113
+ expect(input.focus).toHaveBeenCalledWith({ preventScroll: true });
114
+ expect(field.scrollIntoView).toHaveBeenCalledWith({
115
+ block: "center",
116
+ behavior: "smooth",
117
+ });
118
+ });
119
+
120
+ it("focuses what takes the focus inside the control, as an editor's content", () => {
121
+ const doc: FakeDocument = { activeElement: null };
122
+ const content = control(doc, true);
123
+ const editor = control(doc, false, content);
124
+ const field = fieldElement(doc, { "field-body": editor });
125
+
126
+ expect(focusFieldControl(field, "field-body")).toBe(true);
127
+ expect(content.focus).toHaveBeenCalledTimes(1);
128
+ expect(editor.focus).not.toHaveBeenCalled();
129
+ });
130
+
131
+ it("does not animate the scroll when the operator asks for reduced motion", () => {
132
+ vi.stubGlobal("window", {
133
+ matchMedia: (query: string) => ({
134
+ matches: query === "(prefers-reduced-motion: reduce)",
135
+ }),
136
+ });
137
+ const doc: FakeDocument = { activeElement: null };
138
+ const field = fieldElement(doc, { "field-title": control(doc, true) });
139
+
140
+ focusFieldControl(field, "field-title");
141
+
142
+ expect(field.scrollIntoView).toHaveBeenCalledWith({
143
+ block: "center",
144
+ behavior: "auto",
145
+ });
146
+ });
147
+
148
+ it("answers false when the control does not keep the focus, as a disabled one", () => {
149
+ const doc: FakeDocument = { activeElement: null };
150
+ const disabled = { ...control(doc, true), focus: vi.fn() };
151
+ const field = fieldElement(doc, { "field-title": disabled });
152
+
153
+ expect(focusFieldControl(field, "field-title")).toBe(false);
154
+ });
155
+
156
+ it("answers false before the control renders, or with nothing to focus in it", () => {
157
+ const doc: FakeDocument = { activeElement: null };
158
+ const field = fieldElement(doc, { "field-plain": control(doc, false) });
159
+
160
+ expect(focusFieldControl(field, "field-title")).toBe(false);
161
+ expect(focusFieldControl(field, "field-plain")).toBe(false);
162
+ expect(field.scrollIntoView).not.toHaveBeenCalled();
163
+ });
164
+
165
+ it("answers false for what is not an element, as a headless node", () => {
166
+ expect(focusFieldControl(null, "field-title")).toBe(false);
167
+ expect(focusFieldControl({ tag: "div" }, "field-title")).toBe(false);
168
+ });
169
+
170
+ it("looks the control up by an id written safely into the selector", () => {
171
+ const doc: FakeDocument = { activeElement: null };
172
+ const field = fieldElement(doc, {});
173
+
174
+ focusFieldControl(field, 'field-a"b');
175
+
176
+ expect(field.querySelector).toHaveBeenCalledWith('[id="field-a\\"b"]');
177
+ });
178
+ });