@mapomodule/uikit 2.0.0-beta.8 → 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 (133) hide show
  1. package/README.md +47 -174
  2. package/dist/__tests__/MapoConfirmDialog.component.test.d.ts +2 -0
  3. package/dist/__tests__/MapoConfirmDialog.component.test.d.ts.map +1 -0
  4. package/dist/__tests__/MapoDetail.component.test.d.ts +2 -0
  5. package/dist/__tests__/MapoDetail.component.test.d.ts.map +1 -0
  6. package/dist/__tests__/MapoDetailLangSwitch.component.test.d.ts +2 -0
  7. package/dist/__tests__/MapoDetailLangSwitch.component.test.d.ts.map +1 -0
  8. package/dist/__tests__/MapoListActions.component.test.d.ts +2 -0
  9. package/dist/__tests__/MapoListActions.component.test.d.ts.map +1 -0
  10. package/dist/__tests__/MapoListTable.component.test.d.ts +2 -0
  11. package/dist/__tests__/MapoListTable.component.test.d.ts.map +1 -0
  12. package/dist/__tests__/MapoSnackBar.component.test.d.ts +2 -0
  13. package/dist/__tests__/MapoSnackBar.component.test.d.ts.map +1 -0
  14. package/dist/__tests__/__mocks__/nuxt-app.d.ts +9 -0
  15. package/dist/__tests__/__mocks__/nuxt-app.d.ts.map +1 -0
  16. package/dist/__tests__/formValues.test.d.ts +2 -0
  17. package/dist/__tests__/formValues.test.d.ts.map +1 -0
  18. package/dist/__tests__/langInfo.test.d.ts +2 -0
  19. package/dist/__tests__/langInfo.test.d.ts.map +1 -0
  20. package/dist/__tests__/listTable.test.d.ts +2 -0
  21. package/dist/__tests__/listTable.test.d.ts.map +1 -0
  22. package/dist/__tests__/mediaLanguages.test.d.ts +2 -0
  23. package/dist/__tests__/mediaLanguages.test.d.ts.map +1 -0
  24. package/dist/__tests__/runtimePages.test.d.ts +2 -0
  25. package/dist/__tests__/runtimePages.test.d.ts.map +1 -0
  26. package/dist/index.d.mts +1 -0
  27. package/dist/index.d.ts +1 -0
  28. package/dist/index.d.ts.map +1 -1
  29. package/dist/module.d.mts +1 -0
  30. package/dist/module.d.ts.map +1 -1
  31. package/dist/module.json +1 -1
  32. package/dist/module.mjs +10 -0
  33. package/dist/runtime/assets/main.css +1 -1
  34. package/dist/runtime/components/MapoConfirmDialog.vue +18 -1
  35. package/dist/runtime/components/MapoConfirmDialog.vue.d.ts.map +1 -1
  36. package/dist/runtime/components/MapoDetail.vue +263 -33
  37. package/dist/runtime/components/MapoDetail.vue.d.ts +191 -9
  38. package/dist/runtime/components/MapoDetail.vue.d.ts.map +1 -1
  39. package/dist/runtime/components/MapoDetailExtensions.vue +24 -0
  40. package/dist/runtime/components/MapoDetailExtensions.vue.d.ts +15 -0
  41. package/dist/runtime/components/MapoDetailExtensions.vue.d.ts.map +1 -0
  42. package/dist/runtime/components/MapoDetailLangSwitch.vue +21 -25
  43. package/dist/runtime/components/MapoDetailLangSwitch.vue.d.ts +4 -3
  44. package/dist/runtime/components/MapoDetailLangSwitch.vue.d.ts.map +1 -1
  45. package/dist/runtime/components/MapoDropArea.vue.d.ts +1 -1
  46. package/dist/runtime/components/MapoDropArea.vue.d.ts.map +1 -1
  47. package/dist/runtime/components/MapoList.vue +7 -3
  48. package/dist/runtime/components/MapoList.vue.d.ts +14 -4
  49. package/dist/runtime/components/MapoList.vue.d.ts.map +1 -1
  50. package/dist/runtime/components/MapoListActions.vue +12 -5
  51. package/dist/runtime/components/MapoListActions.vue.d.ts +4 -0
  52. package/dist/runtime/components/MapoListActions.vue.d.ts.map +1 -1
  53. package/dist/runtime/components/MapoListQuickEdit.vue +1 -1
  54. package/dist/runtime/components/MapoListTable.vue +99 -33
  55. package/dist/runtime/components/MapoListTable.vue.d.ts +11 -6
  56. package/dist/runtime/components/MapoListTable.vue.d.ts.map +1 -1
  57. package/dist/runtime/components/MapoMediaEditor.vue +10 -4
  58. package/dist/runtime/components/MapoMediaEditor.vue.d.ts +1 -0
  59. package/dist/runtime/components/MapoMediaEditor.vue.d.ts.map +1 -1
  60. package/dist/runtime/components/MapoMediaFileChanger.vue +1 -1
  61. package/dist/runtime/components/MapoMediaManager.vue +1 -1
  62. package/dist/runtime/components/MapoMediaManagerDialog.vue +1 -1
  63. package/dist/runtime/components/MapoMediaPreview.vue +1 -1
  64. package/dist/runtime/components/MapoMediaUploader.vue +21 -21
  65. package/dist/runtime/components/MapoMediaUploader.vue.d.ts.map +1 -1
  66. package/dist/runtime/components/MapoMenuManager.vue +23 -3
  67. package/dist/runtime/components/MapoMenuManager.vue.d.ts +2 -2
  68. package/dist/runtime/components/MapoMenuManager.vue.d.ts.map +1 -1
  69. package/dist/runtime/components/MapoMenuTreeview.vue.d.ts +1 -1
  70. package/dist/runtime/components/MapoMenuTreeview.vue.d.ts.map +1 -1
  71. package/dist/runtime/components/MapoMenuTreeviewNode.vue.d.ts +2 -2
  72. package/dist/runtime/components/MapoSnackBar.vue +11 -0
  73. package/dist/runtime/components/MapoSnackBar.vue.d.ts.map +1 -1
  74. package/dist/runtime/composables/defineDetailExtension.d.ts +32 -0
  75. package/dist/runtime/composables/defineDetailExtension.d.ts.map +1 -0
  76. package/dist/runtime/composables/defineDetailExtension.js +34 -0
  77. package/dist/runtime/composables/useMapoDetail.d.ts +18 -0
  78. package/dist/runtime/composables/useMapoDetail.d.ts.map +1 -0
  79. package/dist/runtime/composables/useMapoDetail.js +5 -0
  80. package/dist/runtime/page-meta.nuxt.d.ts +4 -0
  81. package/dist/runtime/stores/media.d.ts +8 -2
  82. package/dist/runtime/stores/media.d.ts.map +1 -1
  83. package/dist/runtime/stores/media.js +16 -0
  84. package/dist/runtime/types/detail.d.ts +167 -0
  85. package/dist/runtime/types/detail.d.ts.map +1 -0
  86. package/dist/runtime/types/detail.js +0 -0
  87. package/dist/runtime/types/list.d.ts +10 -2
  88. package/dist/runtime/types/list.d.ts.map +1 -1
  89. package/dist/runtime/utils/formValues.d.ts +8 -0
  90. package/dist/runtime/utils/formValues.d.ts.map +1 -0
  91. package/dist/runtime/utils/formValues.js +19 -0
  92. package/dist/runtime/utils/langInfo.d.ts +30 -0
  93. package/dist/runtime/utils/langInfo.d.ts.map +1 -0
  94. package/dist/runtime/utils/langInfo.js +8 -0
  95. package/dist/runtime/utils/listTable.d.ts +29 -0
  96. package/dist/runtime/utils/listTable.d.ts.map +1 -0
  97. package/dist/runtime/utils/listTable.js +21 -0
  98. package/package.json +7 -8
  99. package/src/__tests__/MapoConfirmDialog.component.test.ts +165 -0
  100. package/src/__tests__/MapoDetail.component.test.ts +1107 -0
  101. package/src/__tests__/MapoDetailLangSwitch.component.test.ts +145 -0
  102. package/src/__tests__/MapoListActions.component.test.ts +175 -0
  103. package/src/__tests__/MapoListTable.component.test.ts +504 -0
  104. package/src/__tests__/MapoSnackBar.component.test.ts +79 -0
  105. package/src/__tests__/__mocks__/nuxt-app.ts +8 -0
  106. package/src/__tests__/formValues.test.ts +31 -0
  107. package/src/__tests__/langInfo.test.ts +48 -0
  108. package/src/__tests__/listTable.test.ts +82 -0
  109. package/src/__tests__/mediaLanguages.test.ts +66 -0
  110. package/src/__tests__/runtimePages.test.ts +17 -0
  111. package/src/index.ts +8 -0
  112. package/src/module.ts +12 -0
  113. package/src/runtime/assets/main.css +13 -0
  114. package/src/runtime/components/MapoConfirmDialog.vue +28 -1
  115. package/src/runtime/components/MapoDetail.vue +481 -53
  116. package/src/runtime/components/MapoDetailExtensions.vue +39 -0
  117. package/src/runtime/components/MapoDetailLangSwitch.vue +26 -27
  118. package/src/runtime/components/MapoList.vue +20 -5
  119. package/src/runtime/components/MapoListActions.vue +16 -4
  120. package/src/runtime/components/MapoListTable.vue +128 -41
  121. package/src/runtime/components/MapoMediaEditor.vue +17 -4
  122. package/src/runtime/components/MapoMediaUploader.vue +25 -21
  123. package/src/runtime/components/MapoMenuManager.vue +38 -3
  124. package/src/runtime/components/MapoSnackBar.vue +12 -0
  125. package/src/runtime/composables/defineDetailExtension.ts +78 -0
  126. package/src/runtime/composables/useMapoDetail.ts +24 -0
  127. package/src/runtime/page-meta.nuxt.d.ts +4 -0
  128. package/src/runtime/stores/media.ts +32 -0
  129. package/src/runtime/types/detail.ts +178 -0
  130. package/src/runtime/types/list.ts +10 -2
  131. package/src/runtime/utils/formValues.ts +28 -0
  132. package/src/runtime/utils/langInfo.ts +38 -0
  133. package/src/runtime/utils/listTable.ts +54 -0
@@ -0,0 +1,82 @@
1
+ import { describe, expect, it } from "vitest";
2
+
3
+ import {
4
+ ALL_ROWS,
5
+ formatPageSize,
6
+ nextSorting,
7
+ orderingParam,
8
+ parsePageSize,
9
+ toPageSize,
10
+ } from "../runtime/utils/listTable";
11
+
12
+ describe("nextSorting", () => {
13
+ it("cycles a column through ascending, descending and unsorted", () => {
14
+ const asc = nextSorting([], "title");
15
+ expect(asc).toEqual([{ id: "title", desc: false }]);
16
+ const desc = nextSorting(asc, "title");
17
+ expect(desc).toEqual([{ id: "title", desc: true }]);
18
+ expect(nextSorting(desc, "title")).toEqual([]);
19
+ });
20
+
21
+ it("replaces the sort on another column", () => {
22
+ expect(
23
+ nextSorting(
24
+ [
25
+ { id: "title", desc: true },
26
+ { id: "status", desc: false },
27
+ ],
28
+ "created_at",
29
+ ),
30
+ ).toEqual([{ id: "created_at", desc: false }]);
31
+ });
32
+
33
+ it("keeps only the clicked key of a multi-column sort", () => {
34
+ // A multi-column sort can come from the URL; a click narrows it to one key.
35
+ expect(
36
+ nextSorting(
37
+ [
38
+ { id: "title", desc: false },
39
+ { id: "status", desc: false },
40
+ ],
41
+ "status",
42
+ ),
43
+ ).toEqual([{ id: "status", desc: true }]);
44
+ });
45
+ });
46
+
47
+ describe("page size helpers", () => {
48
+ it("stores the 'all' option as ALL_ROWS", () => {
49
+ expect(toPageSize("all")).toBe(ALL_ROWS);
50
+ expect(toPageSize(50)).toBe(50);
51
+ });
52
+
53
+ it("reads page_size from the URL", () => {
54
+ expect(parsePageSize("all", 20)).toBe(ALL_ROWS);
55
+ expect(parsePageSize("50", 20)).toBe(50);
56
+ expect(parsePageSize("-3", 20)).toBe(20);
57
+ expect(parsePageSize("abc", 20)).toBe(20);
58
+ expect(parsePageSize(undefined, 20)).toBe(20);
59
+ });
60
+
61
+ it("writes page_size to the URL", () => {
62
+ expect(formatPageSize(ALL_ROWS)).toBe("all");
63
+ expect(formatPageSize(50)).toBe("50");
64
+ });
65
+ });
66
+
67
+ describe("orderingParam", () => {
68
+ it("joins the keys, with `-` for descending", () => {
69
+ expect(
70
+ orderingParam([
71
+ { id: "title", desc: true },
72
+ { id: "published_at", desc: false },
73
+ ]),
74
+ ).toBe("-title,published_at");
75
+ });
76
+
77
+ it("writes a related object's field as a Django lookup", () => {
78
+ expect(orderingParam([{ id: "parent.category.name", desc: true }])).toBe(
79
+ "-parent__category__name",
80
+ );
81
+ });
82
+ });
@@ -0,0 +1,66 @@
1
+ import { describe, it, expect, vi, beforeEach } from "vitest";
2
+ import { createPinia, setActivePinia } from "pinia";
3
+
4
+ const optionsMock = vi.fn();
5
+
6
+ vi.mock("#app", () => ({
7
+ useRuntimeConfig: () => ({ public: {} }),
8
+ useNuxtApp: () => ({ $mapoFetch: vi.fn() }),
9
+ }));
10
+ vi.mock("@mapomodule/core/runtime/api/crud", () => ({
11
+ useCrud: () => ({ options: optionsMock }),
12
+ }));
13
+ vi.mock("@mapomodule/i18n/runtime/composables/useMapoT", () => ({
14
+ useMapoT: () => (key: string) => key,
15
+ }));
16
+
17
+ const { useMediaStore } = await import("../runtime/stores/media");
18
+
19
+ describe("media store — languages from OPTIONS", () => {
20
+ beforeEach(() => {
21
+ setActivePinia(createPinia());
22
+ optionsMock.mockReset();
23
+ });
24
+
25
+ it("reads the media model's own languages", async () => {
26
+ optionsMock.mockResolvedValue({
27
+ lang_info: { translatable: true, languages: ["it", "en"] },
28
+ });
29
+ const store = useMediaStore();
30
+ await store.deriveLanguages();
31
+ expect(store.languages).toEqual(["it", "en"]);
32
+ });
33
+
34
+ it("offers none when the model is not registered for translation", async () => {
35
+ optionsMock.mockResolvedValue({
36
+ lang_info: { translatable: false, languages: [] },
37
+ });
38
+ const store = useMediaStore();
39
+ await store.deriveLanguages();
40
+ expect(store.languages).toEqual([]);
41
+ });
42
+
43
+ // Manager, picker dialog and the `media` form field each mount an editor;
44
+ // without the shared promise that is one OPTIONS request per editor.
45
+ it("asks once however many editors mount", async () => {
46
+ optionsMock.mockResolvedValue({ lang_info: { languages: ["it"] } });
47
+ const store = useMediaStore();
48
+ await Promise.all([
49
+ store.deriveLanguages(),
50
+ store.deriveLanguages(),
51
+ store.deriveLanguages(),
52
+ ]);
53
+ expect(optionsMock).toHaveBeenCalledOnce();
54
+ });
55
+
56
+ it("retries after a failure instead of caching the empty result", async () => {
57
+ optionsMock.mockRejectedValueOnce(new Error("offline"));
58
+ const store = useMediaStore();
59
+ await store.deriveLanguages();
60
+ expect(store.languages).toEqual([]);
61
+
62
+ optionsMock.mockResolvedValue({ lang_info: { languages: ["it"] } });
63
+ await store.deriveLanguages();
64
+ expect(store.languages).toEqual(["it"]);
65
+ });
66
+ });
@@ -0,0 +1,17 @@
1
+ import { readdirSync, readFileSync } from "node:fs";
2
+ import { fileURLToPath } from "node:url";
3
+ import { describe, expect, it } from "vitest";
4
+
5
+ const PAGES = fileURLToPath(new URL("../runtime/pages/", import.meta.url));
6
+
7
+ describe("built-in pages", () => {
8
+ // Apps load these pages from node_modules, where Nuxt adds no auto-imports:
9
+ // a bare `definePageMeta()` there fails with "definePageMeta is not defined".
10
+ it.each(readdirSync(PAGES).filter((file) => file.endsWith(".vue")))(
11
+ "%s leaves its route meta to the module",
12
+ (file) => {
13
+ const source = readFileSync(`${PAGES}${file}`, "utf8");
14
+ expect(source).not.toMatch(/\bdefinePageMeta\s*\(/);
15
+ },
16
+ );
17
+ });
package/src/index.ts CHANGED
@@ -16,6 +16,14 @@ export type {
16
16
  MediaUploadPayload,
17
17
  SelectMode,
18
18
  } from "./runtime/types/media.js";
19
+ export type {
20
+ MapoDetailContext,
21
+ MapoDetailDraft,
22
+ MapoDetailDraftPart,
23
+ DetailExtension,
24
+ DetailExtensionLoader,
25
+ DetailExtensionPlacement,
26
+ } from "./runtime/types/detail.js";
19
27
  export type {
20
28
  MapoMenu,
21
29
  MenuTreeNode,
package/src/module.ts CHANGED
@@ -180,6 +180,7 @@ export default defineNuxtModule<MapoUikitOptions>({
180
180
  "MapoThemeToggle",
181
181
  // ─── CRUD / Detail / List ─────────────────────────────────────────────
182
182
  "MapoDetail",
183
+ "MapoDetailExtensions",
183
184
  "MapoDetailLangSwitch",
184
185
  "MapoList",
185
186
  "MapoListHead",
@@ -267,6 +268,15 @@ export default defineNuxtModule<MapoUikitOptions>({
267
268
  name: "useMediaStore",
268
269
  from: resolver.resolve("./runtime/stores/media"),
269
270
  },
271
+ // The detail context and its extensions
272
+ {
273
+ name: "useMapoDetail",
274
+ from: resolver.resolve("./runtime/composables/useMapoDetail"),
275
+ },
276
+ {
277
+ name: "defineDetailExtension",
278
+ from: resolver.resolve("./runtime/composables/defineDetailExtension"),
279
+ },
270
280
  ]);
271
281
 
272
282
  // MapoOverride* system: if the consuming app has a `mapooverride/` directory
@@ -291,6 +301,8 @@ export default defineNuxtModule<MapoUikitOptions>({
291
301
  // Add a catch-all route for the login page that renders the MapoLogin component.
292
302
  // This allows the login page to be rendered without requiring the consuming app
293
303
  // to create its own login page and route.
304
+ // The layout lives in `meta`, not in a `definePageMeta()` inside the page:
305
+ // apps load these pages from node_modules, where Nuxt adds no auto-imports.
294
306
  if (!pages.some((p) => p.path === "/login"))
295
307
  pages.push({
296
308
  name: "mapo-login",
@@ -12,6 +12,10 @@
12
12
  @source "../../../../form/src/runtime/components/**/*.vue";
13
13
  @source "../../../../form/src/runtime/composables/**/*.ts";
14
14
 
15
+ /* Scan the AI settings components of @mapomodule/ai. An app without the
16
+ package has no such folder, and Tailwind skips a source that is missing. */
17
+ @source "../../../../ai/src/runtime/components/**/*.vue";
18
+
15
19
  /* Safelist: grid utilities used dynamically by the form engine.
16
20
  Tailwind v4 does not scan template literals — these must be explicit. */
17
21
  @source inline("col-span-1 col-span-2 col-span-3 col-span-4 col-span-5 col-span-6 col-span-7 col-span-8 col-span-9 col-span-10 col-span-11 col-span-12");
@@ -56,4 +60,13 @@
56
60
  #__nuxt > * {
57
61
  height: 100%;
58
62
  }
63
+
64
+ /* Tailwind v4 leaves buttons with the browser's arrow and Nuxt UI adds no
65
+ cursor-pointer, so only links (a UButton with `to`) showed the hand. This
66
+ is the rule Tailwind's upgrade guide suggests. A disabled button keeps Nuxt
67
+ UI's `cursor-not-allowed`: a utility, so it wins over this base rule. */
68
+ button:not(:disabled),
69
+ [role="button"]:not(:disabled) {
70
+ cursor: pointer;
71
+ }
59
72
  }
@@ -1,13 +1,40 @@
1
1
  <script setup lang="ts">
2
+ import { ref, watch } from "vue";
2
3
  import { useI18n } from "vue-i18n";
3
4
  import { useConfirmStore } from "@mapomodule/store/runtime/stores/confirm";
4
5
 
5
6
  const { t } = useI18n();
6
7
  const store = useConfirmStore();
8
+
9
+ // Nuxt UI gives overlays no z-index: they stack in the order their portals sit
10
+ // in <body>, and a portal takes its place there when its overlay mounts.
11
+ // Mounted with the layout, this modal would come before every overlay a page
12
+ // opens later, such as the media editor drawer, and show under it while the
13
+ // drawer takes every click. So it mounts when a confirmation is asked, above
14
+ // whatever asked for it, and unmounts once its close animation has ended.
15
+ const modalMounted = ref(store.active);
16
+
17
+ watch(
18
+ () => store.active,
19
+ (active) => {
20
+ if (active) modalMounted.value = true;
21
+ },
22
+ );
23
+
24
+ function onAfterLeave() {
25
+ // Asked again while the previous dialog was closing: it is open again.
26
+ if (store.active) return;
27
+ modalMounted.value = false;
28
+ }
7
29
  </script>
8
30
 
9
31
  <template>
10
- <UModal v-model:open="store.active" :dismissible="false">
32
+ <UModal
33
+ v-if="modalMounted"
34
+ v-model:open="store.active"
35
+ :dismissible="false"
36
+ @after:leave="onAfterLeave"
37
+ >
11
38
  <template #content>
12
39
  <div class="p-6 space-y-4">
13
40
  <div class="space-y-1">