@mapomodule/uikit 2.0.0-beta.3 → 2.0.0-beta.5
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.
- package/README.md +33 -1
- package/dist/index.d.mts +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/module.d.mts +30 -1
- package/dist/module.d.ts +28 -0
- package/dist/module.d.ts.map +1 -1
- package/dist/module.json +1 -1
- package/dist/module.mjs +56 -2
- package/dist/runtime/adapters/defaultMediaAdapter.d.ts +14 -0
- package/dist/runtime/adapters/defaultMediaAdapter.d.ts.map +1 -0
- package/dist/runtime/adapters/defaultMediaAdapter.js +30 -0
- package/dist/runtime/components/MapoDropArea.vue +95 -0
- package/dist/runtime/components/MapoDropArea.vue.d.ts +33 -0
- package/dist/runtime/components/MapoDropArea.vue.d.ts.map +1 -0
- package/dist/runtime/components/MapoMediaBreadcrumbs.vue +45 -0
- package/dist/runtime/components/MapoMediaBreadcrumbs.vue.d.ts +4 -0
- package/dist/runtime/components/MapoMediaBreadcrumbs.vue.d.ts.map +1 -0
- package/dist/runtime/components/MapoMediaEditor.vue +310 -0
- package/dist/runtime/components/MapoMediaEditor.vue.d.ts +8 -0
- package/dist/runtime/components/MapoMediaEditor.vue.d.ts.map +1 -0
- package/dist/runtime/components/MapoMediaFileChanger.vue +108 -0
- package/dist/runtime/components/MapoMediaFileChanger.vue.d.ts +15 -0
- package/dist/runtime/components/MapoMediaFileChanger.vue.d.ts.map +1 -0
- package/dist/runtime/components/MapoMediaFolders.vue +198 -0
- package/dist/runtime/components/MapoMediaFolders.vue.d.ts +4 -0
- package/dist/runtime/components/MapoMediaFolders.vue.d.ts.map +1 -0
- package/dist/runtime/components/MapoMediaGallery.vue +209 -0
- package/dist/runtime/components/MapoMediaGallery.vue.d.ts +4 -0
- package/dist/runtime/components/MapoMediaGallery.vue.d.ts.map +1 -0
- package/dist/runtime/components/MapoMediaManager.vue +130 -0
- package/dist/runtime/components/MapoMediaManager.vue.d.ts +35 -0
- package/dist/runtime/components/MapoMediaManager.vue.d.ts.map +1 -0
- package/dist/runtime/components/MapoMediaManagerDialog.vue +112 -0
- package/dist/runtime/components/MapoMediaManagerDialog.vue.d.ts +41 -0
- package/dist/runtime/components/MapoMediaManagerDialog.vue.d.ts.map +1 -0
- package/dist/runtime/components/MapoMediaPreview.vue +92 -0
- package/dist/runtime/components/MapoMediaPreview.vue.d.ts +19 -0
- package/dist/runtime/components/MapoMediaPreview.vue.d.ts.map +1 -0
- package/dist/runtime/components/MapoMediaUploader.vue +266 -0
- package/dist/runtime/components/MapoMediaUploader.vue.d.ts +8 -0
- package/dist/runtime/components/MapoMediaUploader.vue.d.ts.map +1 -0
- package/dist/runtime/pages/index.vue +0 -1
- package/dist/runtime/pages/index.vue.d.ts.map +1 -1
- package/dist/runtime/pages/login.vue +0 -4
- package/dist/runtime/pages/login.vue.d.ts.map +1 -1
- package/dist/runtime/plugins/media-adapter.d.ts +18 -0
- package/dist/runtime/plugins/media-adapter.d.ts.map +1 -0
- package/dist/runtime/plugins/media-adapter.js +7 -0
- package/dist/runtime/stores/media.d.ts +462 -0
- package/dist/runtime/stores/media.d.ts.map +1 -0
- package/dist/runtime/stores/media.js +323 -0
- package/dist/runtime/types/media.d.ts +116 -0
- package/dist/runtime/types/media.d.ts.map +1 -0
- package/dist/runtime/types/media.js +0 -0
- package/dist/types.d.mts +1 -1
- package/package.json +8 -6
- package/src/index.ts +8 -0
- package/src/module.ts +113 -0
- package/src/runtime/adapters/defaultMediaAdapter.ts +57 -0
- package/src/runtime/components/MapoDropArea.vue +122 -0
- package/src/runtime/components/MapoMediaBreadcrumbs.vue +51 -0
- package/src/runtime/components/MapoMediaEditor.vue +340 -0
- package/src/runtime/components/MapoMediaFileChanger.vue +131 -0
- package/src/runtime/components/MapoMediaFolders.vue +217 -0
- package/src/runtime/components/MapoMediaGallery.vue +227 -0
- package/src/runtime/components/MapoMediaManager.vue +170 -0
- package/src/runtime/components/MapoMediaManagerDialog.vue +142 -0
- package/src/runtime/components/MapoMediaPreview.vue +111 -0
- package/src/runtime/components/MapoMediaUploader.vue +324 -0
- package/src/runtime/pages/index.vue +0 -2
- package/src/runtime/pages/login.vue +0 -4
- package/src/runtime/plugins/media-adapter.ts +29 -0
- package/src/runtime/stores/media.ts +435 -0
- package/src/runtime/types/media.ts +126 -0
|
@@ -0,0 +1,323 @@
|
|
|
1
|
+
import { defineStore } from "pinia";
|
|
2
|
+
import { ref, computed, shallowRef } from "vue";
|
|
3
|
+
import { useConfirmStore } from "@mapomodule/store/runtime/stores/confirm";
|
|
4
|
+
import { useSnackStore } from "@mapomodule/store/runtime/stores/snack";
|
|
5
|
+
import { useCrud } from "@mapomodule/core/runtime/api/crud";
|
|
6
|
+
import { useNuxtApp, useRuntimeConfig } from "#app";
|
|
7
|
+
import { defaultMediaAdapter } from "../adapters/defaultMediaAdapter.js";
|
|
8
|
+
export const useMediaStore = defineStore("mapo-media", () => {
|
|
9
|
+
const runtimeConfig = useRuntimeConfig();
|
|
10
|
+
const mediaConfig = runtimeConfig.public.mapoMedia ?? {};
|
|
11
|
+
const endpoints = {
|
|
12
|
+
media: mediaConfig.endpoints?.media ?? "/api/media",
|
|
13
|
+
folders: mediaConfig.endpoints?.folders ?? "/api/media-folders"
|
|
14
|
+
};
|
|
15
|
+
function adapter() {
|
|
16
|
+
const nuxt = useNuxtApp();
|
|
17
|
+
return nuxt.$mapoMediaAdapter ?? defaultMediaAdapter;
|
|
18
|
+
}
|
|
19
|
+
const medias = ref([]);
|
|
20
|
+
const folders = ref([]);
|
|
21
|
+
const parentFolders = ref([]);
|
|
22
|
+
const page = ref(1);
|
|
23
|
+
const pages = ref(1);
|
|
24
|
+
const mimeType = ref(null);
|
|
25
|
+
const lockedMime = ref(null);
|
|
26
|
+
const loading = ref(false);
|
|
27
|
+
const editMedia = ref(null);
|
|
28
|
+
const selection = shallowRef(null);
|
|
29
|
+
const editList = ref([]);
|
|
30
|
+
const selectMode = ref("none");
|
|
31
|
+
const _currentFolderId = ref(null);
|
|
32
|
+
const _currentSearch = ref("");
|
|
33
|
+
const _currentAll = ref(false);
|
|
34
|
+
const _currentLang = ref(void 0);
|
|
35
|
+
const parentFolder = computed(
|
|
36
|
+
() => parentFolders.value[parentFolders.value.length - 1] ?? null
|
|
37
|
+
);
|
|
38
|
+
const editListSet = computed(() => new Set(editList.value));
|
|
39
|
+
const editListState = computed(() => {
|
|
40
|
+
const total = medias.value.length;
|
|
41
|
+
const selected = editList.value.filter(
|
|
42
|
+
(id) => medias.value.some((m) => m.id === id)
|
|
43
|
+
).length;
|
|
44
|
+
if (total === 0 || selected === 0)
|
|
45
|
+
return {
|
|
46
|
+
value: false,
|
|
47
|
+
indeterminate: false,
|
|
48
|
+
outside: editList.value.length > 0
|
|
49
|
+
};
|
|
50
|
+
if (selected === total)
|
|
51
|
+
return { value: true, indeterminate: false, outside: false };
|
|
52
|
+
return { value: false, indeterminate: true, outside: false };
|
|
53
|
+
});
|
|
54
|
+
function mediaCrud() {
|
|
55
|
+
return useCrud(endpoints.media);
|
|
56
|
+
}
|
|
57
|
+
function folderCrud() {
|
|
58
|
+
return useCrud(endpoints.folders);
|
|
59
|
+
}
|
|
60
|
+
function applyParentFolder(pf) {
|
|
61
|
+
if (!pf) {
|
|
62
|
+
parentFolders.value = [];
|
|
63
|
+
return;
|
|
64
|
+
}
|
|
65
|
+
const key = pf.path ?? pf.id;
|
|
66
|
+
const idx = parentFolders.value.findIndex((f) => (f.path ?? f.id) === key);
|
|
67
|
+
if (idx === -1) {
|
|
68
|
+
parentFolders.value = [...parentFolders.value, pf];
|
|
69
|
+
} else {
|
|
70
|
+
parentFolders.value = parentFolders.value.slice(0, idx + 1);
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
async function getRoot(params = {}) {
|
|
74
|
+
loading.value = true;
|
|
75
|
+
if (params.search !== void 0) _currentSearch.value = params.search;
|
|
76
|
+
if (params.all !== void 0) _currentAll.value = params.all;
|
|
77
|
+
const all = _currentAll.value;
|
|
78
|
+
const folderId = all ? null : _currentFolderId.value;
|
|
79
|
+
try {
|
|
80
|
+
const a = adapter();
|
|
81
|
+
const listParams = (a.buildListParams ?? defaultMediaAdapter.buildListParams)({
|
|
82
|
+
page: params.page ?? page.value,
|
|
83
|
+
search: _currentSearch.value || void 0,
|
|
84
|
+
mime: mimeType.value,
|
|
85
|
+
all: all || void 0
|
|
86
|
+
});
|
|
87
|
+
const crud = folderCrud();
|
|
88
|
+
const raw = folderId != null ? await crud.detail(folderId, { params: listParams }) : await crud.list(listParams);
|
|
89
|
+
const data = (a.parseRootResponse ?? defaultMediaAdapter.parseRootResponse)(raw);
|
|
90
|
+
medias.value = data.media.items;
|
|
91
|
+
page.value = data.media.paginator.page;
|
|
92
|
+
pages.value = data.media.paginator.pages;
|
|
93
|
+
folders.value = data.folders;
|
|
94
|
+
applyParentFolder(data.parent_folder);
|
|
95
|
+
} finally {
|
|
96
|
+
loading.value = false;
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
async function navigateToFolder(folder) {
|
|
100
|
+
_currentFolderId.value = folder?.id ?? null;
|
|
101
|
+
_currentSearch.value = "";
|
|
102
|
+
_currentAll.value = false;
|
|
103
|
+
await getRoot({ page: 1 });
|
|
104
|
+
}
|
|
105
|
+
async function openEditor(media) {
|
|
106
|
+
try {
|
|
107
|
+
const a = adapter();
|
|
108
|
+
const params = (a.buildDetailParams ?? defaultMediaAdapter.buildDetailParams)({ lang: _currentLang.value });
|
|
109
|
+
const detail = await mediaCrud().detail(media.id, { params });
|
|
110
|
+
editMedia.value = detail;
|
|
111
|
+
} catch {
|
|
112
|
+
editMedia.value = media;
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
function closeEditor() {
|
|
116
|
+
editMedia.value = null;
|
|
117
|
+
}
|
|
118
|
+
function setLang(lang) {
|
|
119
|
+
_currentLang.value = lang;
|
|
120
|
+
}
|
|
121
|
+
async function updateMedia(media) {
|
|
122
|
+
const a = adapter();
|
|
123
|
+
const payload = (a.buildMediaPatchPayload ?? defaultMediaAdapter.buildMediaPatchPayload)(media);
|
|
124
|
+
const updated = await mediaCrud().partialUpdate(media.id, payload);
|
|
125
|
+
if (editMedia.value?.id === media.id) editMedia.value = updated;
|
|
126
|
+
useSnackStore().show("Media updated", "success");
|
|
127
|
+
await getRoot();
|
|
128
|
+
return updated;
|
|
129
|
+
}
|
|
130
|
+
async function replaceFile(mediaId, file, maintainUrl = false) {
|
|
131
|
+
const a = adapter();
|
|
132
|
+
const payload = (a.buildReplaceFilePayload ?? defaultMediaAdapter.buildReplaceFilePayload)(file, maintainUrl);
|
|
133
|
+
const updated = await mediaCrud().partialUpdate(
|
|
134
|
+
mediaId,
|
|
135
|
+
payload,
|
|
136
|
+
void 0,
|
|
137
|
+
{ multipart: "force" }
|
|
138
|
+
);
|
|
139
|
+
if (editMedia.value?.id === mediaId) editMedia.value = updated;
|
|
140
|
+
return updated;
|
|
141
|
+
}
|
|
142
|
+
async function updateOrCreateFolder(folder) {
|
|
143
|
+
const a = adapter();
|
|
144
|
+
const payload = (a.buildFolderPayload ?? defaultMediaAdapter.buildFolderPayload)({
|
|
145
|
+
parent: _currentFolderId.value,
|
|
146
|
+
...folder
|
|
147
|
+
});
|
|
148
|
+
await folderCrud().updateOrCreate(payload);
|
|
149
|
+
await getRoot();
|
|
150
|
+
}
|
|
151
|
+
async function deleteFolder(folder) {
|
|
152
|
+
const confirmed = await useConfirmStore().ask({
|
|
153
|
+
title: "Delete folder",
|
|
154
|
+
message: `Delete folder "${folder.name}"? Media inside it will not be deleted.`,
|
|
155
|
+
confirmText: "Delete",
|
|
156
|
+
dangerous: true
|
|
157
|
+
});
|
|
158
|
+
if (!confirmed) return;
|
|
159
|
+
await folderCrud().delete(folder.id);
|
|
160
|
+
await getRoot();
|
|
161
|
+
}
|
|
162
|
+
async function deleteMedia(media) {
|
|
163
|
+
const confirmed = await useConfirmStore().ask({
|
|
164
|
+
title: "Delete media",
|
|
165
|
+
message: `Delete "${media.title || media.file}"?`,
|
|
166
|
+
confirmText: "Delete",
|
|
167
|
+
dangerous: true
|
|
168
|
+
});
|
|
169
|
+
if (!confirmed) return;
|
|
170
|
+
await mediaCrud().delete(media.id);
|
|
171
|
+
if (editMedia.value?.id === media.id) editMedia.value = null;
|
|
172
|
+
await getRoot();
|
|
173
|
+
}
|
|
174
|
+
function select(media) {
|
|
175
|
+
if (selectMode.value === "none") {
|
|
176
|
+
openEditor(media);
|
|
177
|
+
return;
|
|
178
|
+
}
|
|
179
|
+
if (selectMode.value === "single") {
|
|
180
|
+
selection.value = media;
|
|
181
|
+
return;
|
|
182
|
+
}
|
|
183
|
+
const current = selection.value ?? [];
|
|
184
|
+
const idx = current.findIndex((m) => m.id === media.id);
|
|
185
|
+
selection.value = idx === -1 ? [...current, media] : current.filter((m) => m.id !== media.id);
|
|
186
|
+
}
|
|
187
|
+
function setSelectionMode(mode) {
|
|
188
|
+
selectMode.value = mode;
|
|
189
|
+
selection.value = mode === "multi" ? [] : null;
|
|
190
|
+
}
|
|
191
|
+
function setSelection(value) {
|
|
192
|
+
selection.value = value;
|
|
193
|
+
}
|
|
194
|
+
function editSelect(id) {
|
|
195
|
+
const ids = Array.isArray(id) ? id : [id];
|
|
196
|
+
const set = new Set(editList.value);
|
|
197
|
+
for (const i of ids) {
|
|
198
|
+
if (set.has(i)) set.delete(i);
|
|
199
|
+
else set.add(i);
|
|
200
|
+
}
|
|
201
|
+
editList.value = Array.from(set);
|
|
202
|
+
}
|
|
203
|
+
function editSelectAll() {
|
|
204
|
+
const allIds = medias.value.map((m) => m.id);
|
|
205
|
+
const allSelected = allIds.every((id) => editListSet.value.has(id));
|
|
206
|
+
if (allSelected) {
|
|
207
|
+
editList.value = editList.value.filter((id) => !allIds.includes(id));
|
|
208
|
+
} else {
|
|
209
|
+
const set = /* @__PURE__ */ new Set([...editList.value, ...allIds]);
|
|
210
|
+
editList.value = Array.from(set);
|
|
211
|
+
}
|
|
212
|
+
}
|
|
213
|
+
async function deleteSelected() {
|
|
214
|
+
const count = editList.value.length;
|
|
215
|
+
if (count === 0) return;
|
|
216
|
+
const confirmed = await useConfirmStore().ask({
|
|
217
|
+
title: "Delete selected media",
|
|
218
|
+
message: `Delete ${count} selected media?`,
|
|
219
|
+
confirmText: `Delete ${count}`,
|
|
220
|
+
dangerous: true
|
|
221
|
+
});
|
|
222
|
+
if (!confirmed) return;
|
|
223
|
+
await Promise.all(editList.value.map((id) => mediaCrud().delete(id)));
|
|
224
|
+
editList.value = [];
|
|
225
|
+
useSnackStore().show(`${count} media deleted`, "success");
|
|
226
|
+
await getRoot();
|
|
227
|
+
}
|
|
228
|
+
async function uploadMedia(payload, onProgress) {
|
|
229
|
+
const formData = new FormData();
|
|
230
|
+
formData.append("file", payload.file);
|
|
231
|
+
if (payload.title) formData.append("title", payload.title);
|
|
232
|
+
if (payload.alt_text) formData.append("alt_text", payload.alt_text);
|
|
233
|
+
if (payload.description)
|
|
234
|
+
formData.append("description", payload.description);
|
|
235
|
+
if (payload.folder != null)
|
|
236
|
+
formData.append("folder", String(payload.folder));
|
|
237
|
+
return await new Promise((resolve, reject) => {
|
|
238
|
+
const xhr = new XMLHttpRequest();
|
|
239
|
+
xhr.open("POST", `${endpoints.media.replace(/\/+$/, "")}/`);
|
|
240
|
+
xhr.responseType = "json";
|
|
241
|
+
if (onProgress) {
|
|
242
|
+
xhr.upload.addEventListener("progress", (event) => {
|
|
243
|
+
if (event.lengthComputable)
|
|
244
|
+
onProgress(Math.round(event.loaded / event.total * 100));
|
|
245
|
+
});
|
|
246
|
+
}
|
|
247
|
+
xhr.addEventListener("load", () => {
|
|
248
|
+
if (xhr.status >= 200 && xhr.status < 300) {
|
|
249
|
+
resolve(xhr.response);
|
|
250
|
+
} else {
|
|
251
|
+
const detail = xhr.response?.detail;
|
|
252
|
+
reject(new Error(detail || `Upload failed (${xhr.status})`));
|
|
253
|
+
}
|
|
254
|
+
});
|
|
255
|
+
xhr.addEventListener("error", () => reject(new Error("Upload failed")));
|
|
256
|
+
xhr.send(formData);
|
|
257
|
+
});
|
|
258
|
+
}
|
|
259
|
+
function setMimeType(mime) {
|
|
260
|
+
mimeType.value = mime ?? lockedMime.value;
|
|
261
|
+
}
|
|
262
|
+
function lockMimeType(mime) {
|
|
263
|
+
lockedMime.value = mime;
|
|
264
|
+
if (mime) mimeType.value = mime;
|
|
265
|
+
}
|
|
266
|
+
function reset() {
|
|
267
|
+
medias.value = [];
|
|
268
|
+
folders.value = [];
|
|
269
|
+
parentFolders.value = [];
|
|
270
|
+
page.value = 1;
|
|
271
|
+
pages.value = 1;
|
|
272
|
+
mimeType.value = null;
|
|
273
|
+
lockedMime.value = null;
|
|
274
|
+
loading.value = false;
|
|
275
|
+
editMedia.value = null;
|
|
276
|
+
selection.value = null;
|
|
277
|
+
editList.value = [];
|
|
278
|
+
selectMode.value = "none";
|
|
279
|
+
_currentFolderId.value = null;
|
|
280
|
+
_currentSearch.value = "";
|
|
281
|
+
_currentAll.value = false;
|
|
282
|
+
}
|
|
283
|
+
return {
|
|
284
|
+
// state
|
|
285
|
+
medias,
|
|
286
|
+
folders,
|
|
287
|
+
parentFolders,
|
|
288
|
+
page,
|
|
289
|
+
pages,
|
|
290
|
+
mimeType,
|
|
291
|
+
lockedMime,
|
|
292
|
+
loading,
|
|
293
|
+
editMedia,
|
|
294
|
+
selection,
|
|
295
|
+
editList,
|
|
296
|
+
selectMode,
|
|
297
|
+
// getters
|
|
298
|
+
parentFolder,
|
|
299
|
+
editListSet,
|
|
300
|
+
editListState,
|
|
301
|
+
// actions
|
|
302
|
+
getRoot,
|
|
303
|
+
navigateToFolder,
|
|
304
|
+
openEditor,
|
|
305
|
+
closeEditor,
|
|
306
|
+
setLang,
|
|
307
|
+
updateMedia,
|
|
308
|
+
replaceFile,
|
|
309
|
+
updateOrCreateFolder,
|
|
310
|
+
deleteFolder,
|
|
311
|
+
deleteMedia,
|
|
312
|
+
select,
|
|
313
|
+
setSelectionMode,
|
|
314
|
+
setSelection,
|
|
315
|
+
editSelect,
|
|
316
|
+
editSelectAll,
|
|
317
|
+
deleteSelected,
|
|
318
|
+
uploadMedia,
|
|
319
|
+
setMimeType,
|
|
320
|
+
lockMimeType,
|
|
321
|
+
reset
|
|
322
|
+
};
|
|
323
|
+
});
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Media **value** types are owned by `@mapomodule/form` (they are the value that
|
|
3
|
+
* lands in the form model, next to their descriptors) and re-exported here so the
|
|
4
|
+
* Media Manager keeps a single import surface. `uikit` already depends on `form`,
|
|
5
|
+
* so this direction introduces no cycle.
|
|
6
|
+
*/
|
|
7
|
+
export type { MediaLink, MediaItem, EnhancedMediaValue, } from "@mapomodule/form/types";
|
|
8
|
+
import type { MediaItem } from "@mapomodule/form/types";
|
|
9
|
+
export interface MediaFolder {
|
|
10
|
+
id: number;
|
|
11
|
+
name: string;
|
|
12
|
+
parent?: number | null;
|
|
13
|
+
/**
|
|
14
|
+
* Materialized path of the folder (e.g. "root/images/hero").
|
|
15
|
+
* Camomilla returns it and the breadcrumb uses it for deduplication.
|
|
16
|
+
* Falls back to `id` when absent.
|
|
17
|
+
*/
|
|
18
|
+
path?: string;
|
|
19
|
+
}
|
|
20
|
+
export interface MediaApiResponse {
|
|
21
|
+
media: {
|
|
22
|
+
items: MediaItem[];
|
|
23
|
+
paginator: {
|
|
24
|
+
page: number;
|
|
25
|
+
pages: number;
|
|
26
|
+
};
|
|
27
|
+
};
|
|
28
|
+
folders: MediaFolder[];
|
|
29
|
+
parent_folder: MediaFolder | null;
|
|
30
|
+
}
|
|
31
|
+
export type SelectMode = "none" | "single" | "multi";
|
|
32
|
+
export interface MediaGetRootParams {
|
|
33
|
+
page?: number;
|
|
34
|
+
folder?: number | null;
|
|
35
|
+
search?: string;
|
|
36
|
+
mime?: string | null;
|
|
37
|
+
all?: boolean;
|
|
38
|
+
}
|
|
39
|
+
export interface MediaUploadPayload {
|
|
40
|
+
file: File;
|
|
41
|
+
title?: string;
|
|
42
|
+
alt_text?: string;
|
|
43
|
+
description?: string;
|
|
44
|
+
folder?: number | null;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* REST endpoints used by the media store. Configured via
|
|
48
|
+
* `mapo.uikit.media.endpoints` in `nuxt.config.ts` and forwarded to
|
|
49
|
+
* `runtimeConfig.public.mapoMedia`.
|
|
50
|
+
*/
|
|
51
|
+
export interface MediaEndpoints {
|
|
52
|
+
/** Single-media CRUD: detail, partialUpdate, delete, upload (POST). Default `/api/media`. */
|
|
53
|
+
media: string;
|
|
54
|
+
/** Folder navigation + CRUD: list (root), detail (enter folder), create, delete. Default `/api/media-folders`. */
|
|
55
|
+
folders: string;
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* Context passed to the adapter when building list/detail query params.
|
|
59
|
+
* Values are the **canonical** Mapo params — the adapter maps them to the
|
|
60
|
+
* shape the target backend expects (e.g. `mime` → `fltr=mime_type=`).
|
|
61
|
+
*/
|
|
62
|
+
export interface MediaListParamsContext {
|
|
63
|
+
page?: number;
|
|
64
|
+
search?: string;
|
|
65
|
+
mime?: string | null;
|
|
66
|
+
all?: boolean;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Backend adapter for the media store. Lets integrations (e.g. Camomilla)
|
|
70
|
+
* remap request params and normalize responses without coupling the store to a
|
|
71
|
+
* specific backend. Injected as `$mapoMediaAdapter` by a Nuxt plugin — functions
|
|
72
|
+
* are not serializable through `runtimeConfig`, so this mirrors the
|
|
73
|
+
* `$mapoFormRegistry` pattern.
|
|
74
|
+
*
|
|
75
|
+
* Every method is optional; the default adapter applies plain REST semantics.
|
|
76
|
+
*/
|
|
77
|
+
export interface MediaAdapter {
|
|
78
|
+
/**
|
|
79
|
+
* Build the query params object for the `getRoot` list/detail request.
|
|
80
|
+
* @example
|
|
81
|
+
* // Camomilla: { page, search, fltr: 'mime_type=image/png' }
|
|
82
|
+
*/
|
|
83
|
+
buildListParams?(ctx: MediaListParamsContext): Record<string, unknown>;
|
|
84
|
+
/**
|
|
85
|
+
* Normalize a raw `getRoot` response (folder list or detail) into the
|
|
86
|
+
* canonical {@link MediaApiResponse} shape. Default = identity.
|
|
87
|
+
*/
|
|
88
|
+
parseRootResponse?(raw: unknown): MediaApiResponse;
|
|
89
|
+
/**
|
|
90
|
+
* Build query params for the single-media detail fetch (`openEditor`).
|
|
91
|
+
* @example
|
|
92
|
+
* // Camomilla: { language_code: 'it' }
|
|
93
|
+
*/
|
|
94
|
+
buildDetailParams?(ctx: {
|
|
95
|
+
lang?: string;
|
|
96
|
+
}): Record<string, unknown>;
|
|
97
|
+
/**
|
|
98
|
+
* Map a canonical folder (`{ name, parent }`) to the backend's create/update
|
|
99
|
+
* payload.
|
|
100
|
+
* @example
|
|
101
|
+
* // Camomilla: { title, slug: slugify(title), updir: parent }
|
|
102
|
+
*/
|
|
103
|
+
buildFolderPayload?(folder: Partial<MediaFolder>): Record<string, unknown>;
|
|
104
|
+
/**
|
|
105
|
+
* Build the PATCH payload for a media metadata update.
|
|
106
|
+
* Default: `{ title, alt_text, description, translations }`.
|
|
107
|
+
*/
|
|
108
|
+
buildMediaPatchPayload?(media: MediaItem): Record<string, unknown>;
|
|
109
|
+
/**
|
|
110
|
+
* Build the multipart PATCH payload for a file replacement.
|
|
111
|
+
* @example
|
|
112
|
+
* // Default REST: { file, maintain_url } — Camomilla: { file, same_url }
|
|
113
|
+
*/
|
|
114
|
+
buildReplaceFilePayload?(file: File, maintainUrl: boolean): Record<string, unknown>;
|
|
115
|
+
}
|
|
116
|
+
//# sourceMappingURL=media.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"media.d.ts","sourceRoot":"","sources":["../../../src/runtime/types/media.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,YAAY,EACV,SAAS,EACT,SAAS,EACT,kBAAkB,GACnB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAExD,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE;QACL,KAAK,EAAE,SAAS,EAAE,CAAC;QACnB,SAAS,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,CAAC;KAC5C,CAAC;IACF,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,aAAa,EAAE,WAAW,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;AAErD,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,6FAA6F;IAC7F,KAAK,EAAE,MAAM,CAAC;IACd,kHAAkH;IAClH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,eAAe,CAAC,CAAC,GAAG,EAAE,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvE;;;OAGG;IACH,iBAAiB,CAAC,CAAC,GAAG,EAAE,OAAO,GAAG,gBAAgB,CAAC;IACnD;;;;OAIG;IACH,iBAAiB,CAAC,CAAC,GAAG,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpE;;;;;OAKG;IACH,kBAAkB,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3E;;;OAGG;IACH,sBAAsB,CAAC,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnE;;;;OAIG;IACH,uBAAuB,CAAC,CACtB,IAAI,EAAE,IAAI,EACV,WAAW,EAAE,OAAO,GACnB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC5B"}
|
|
File without changes
|
package/dist/types.d.mts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mapomodule/uikit",
|
|
3
|
-
"version": "2.0.0-beta.
|
|
3
|
+
"version": "2.0.0-beta.5",
|
|
4
4
|
"description": "Mapo UI components: Sidebar, Topbar, Login, SnackBar, ConfirmDialog, List, Detail, Media",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -46,15 +46,16 @@
|
|
|
46
46
|
"lint": "eslint src"
|
|
47
47
|
},
|
|
48
48
|
"dependencies": {
|
|
49
|
-
"@mapomodule/form": "2.0.0-beta.
|
|
50
|
-
"@mapomodule/store": "2.0.0-beta.
|
|
51
|
-
"@mapomodule/utils": "2.0.0-beta.
|
|
52
|
-
"@mapomodule/core": "2.0.0-beta.
|
|
49
|
+
"@mapomodule/form": "2.0.0-beta.5",
|
|
50
|
+
"@mapomodule/store": "2.0.0-beta.4",
|
|
51
|
+
"@mapomodule/utils": "2.0.0-beta.2",
|
|
52
|
+
"@mapomodule/core": "2.0.0-beta.5",
|
|
53
53
|
"tailwindcss": "^4.0.0"
|
|
54
54
|
},
|
|
55
55
|
"peerDependencies": {
|
|
56
56
|
"@nuxt/ui": ">=4.0.0",
|
|
57
|
-
"nuxt": ">=4.0.0"
|
|
57
|
+
"nuxt": ">=4.0.0",
|
|
58
|
+
"pinia": ">=3.0.0"
|
|
58
59
|
},
|
|
59
60
|
"devDependencies": {
|
|
60
61
|
"@nuxt/kit": "4.4.2",
|
|
@@ -63,6 +64,7 @@
|
|
|
63
64
|
"@nuxt/ui": "^4.7.0",
|
|
64
65
|
"@tanstack/vue-table": "^8.21.3",
|
|
65
66
|
"nuxt": "^4.4.2",
|
|
67
|
+
"pinia": "^3.0.4",
|
|
66
68
|
"vue": "^3.5.32",
|
|
67
69
|
"vue-router": "^5.0.4",
|
|
68
70
|
"vue-tsc": "^3.3.4"
|
package/src/index.ts
CHANGED
package/src/module.ts
CHANGED
|
@@ -4,6 +4,8 @@ import {
|
|
|
4
4
|
defineNuxtModule,
|
|
5
5
|
addComponent,
|
|
6
6
|
addLayout,
|
|
7
|
+
addPlugin,
|
|
8
|
+
addImports,
|
|
7
9
|
addTypeTemplate,
|
|
8
10
|
createResolver,
|
|
9
11
|
extendPages,
|
|
@@ -33,8 +35,49 @@ export interface MapoUikitOptions {
|
|
|
33
35
|
* @see https://ui.nuxt.com/getting-started/theme
|
|
34
36
|
*/
|
|
35
37
|
ui?: Record<string, unknown>;
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* Media Manager configuration. Endpoints and upload limits are
|
|
41
|
+
* forwarded to `runtimeConfig.public.mapoMedia` and read by `useMediaStore`.
|
|
42
|
+
*/
|
|
43
|
+
media?: MapoMediaOptions;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
export interface MapoMediaOptions {
|
|
47
|
+
/**
|
|
48
|
+
* REST endpoints used by the media store.
|
|
49
|
+
* Defaults align with the Camomilla integration path-rewrites.
|
|
50
|
+
*/
|
|
51
|
+
endpoints?: {
|
|
52
|
+
/** Single-media CRUD (detail, update, delete, upload). Default `/api/media`. */
|
|
53
|
+
media?: string;
|
|
54
|
+
/** Folder navigation + CRUD. Default `/api/media-folders`. */
|
|
55
|
+
folders?: string;
|
|
56
|
+
};
|
|
57
|
+
/** Max image upload size in MB. Default 10. */
|
|
58
|
+
maxImageSize?: number;
|
|
59
|
+
/** Max video upload size in MB. Default 100. */
|
|
60
|
+
maxVideoSize?: number;
|
|
61
|
+
/** Max size for any other file type in MB. Default 10. */
|
|
62
|
+
maxDefaultSize?: number;
|
|
63
|
+
/**
|
|
64
|
+
* Django model used for media permission checks (`change_<model>`,
|
|
65
|
+
* `delete_<model>`) in the editor. Default `"media"`.
|
|
66
|
+
*/
|
|
67
|
+
permissionsModel?: string;
|
|
36
68
|
}
|
|
37
69
|
|
|
70
|
+
const MAPO_MEDIA_DEFAULTS = {
|
|
71
|
+
endpoints: {
|
|
72
|
+
media: "/api/media",
|
|
73
|
+
folders: "/api/media-folders",
|
|
74
|
+
},
|
|
75
|
+
maxImageSize: 10,
|
|
76
|
+
maxVideoSize: 100,
|
|
77
|
+
maxDefaultSize: 10,
|
|
78
|
+
permissionsModel: "media",
|
|
79
|
+
} satisfies Required<MapoMediaOptions>;
|
|
80
|
+
|
|
38
81
|
export default defineNuxtModule<MapoUikitOptions>({
|
|
39
82
|
meta: {
|
|
40
83
|
name: "@mapomodule/uikit",
|
|
@@ -55,6 +98,16 @@ export default defineNuxtModule<MapoUikitOptions>({
|
|
|
55
98
|
async setup(options, nuxt) {
|
|
56
99
|
const resolver = createResolver(import.meta.url);
|
|
57
100
|
|
|
101
|
+
// In consuming apps this runtime lives inside node_modules, where Nuxt
|
|
102
|
+
// skips auto-import injection by default (workspace apps are unaffected:
|
|
103
|
+
// pnpm symlinks resolve outside node_modules). Opt back in and transpile
|
|
104
|
+
// the runtime for the SSR build.
|
|
105
|
+
nuxt.options.build.transpile.push(resolver.resolve("./runtime"));
|
|
106
|
+
nuxt.options.imports.transform ??= {};
|
|
107
|
+
(nuxt.options.imports.transform.include ??= []).push(
|
|
108
|
+
/@mapomodule[\\/]uikit[\\/]/,
|
|
109
|
+
);
|
|
110
|
+
|
|
58
111
|
addTypeTemplate({
|
|
59
112
|
filename: "types/mapo-uikit-page-meta.d.ts",
|
|
60
113
|
getContents: () =>
|
|
@@ -85,7 +138,25 @@ export default defineNuxtModule<MapoUikitOptions>({
|
|
|
85
138
|
nuxt.options.ui = { ...options.ui, ...(nuxt.options.ui ?? {}) };
|
|
86
139
|
}
|
|
87
140
|
|
|
141
|
+
// Media config → runtimeConfig.public.mapoMedia (read by useMediaStore + uploader).
|
|
142
|
+
// Only serializable values; the adapter functions go through the plugin below.
|
|
143
|
+
const media = options.media ?? {};
|
|
144
|
+
nuxt.options.runtimeConfig.public.mapoMedia = {
|
|
145
|
+
endpoints: {
|
|
146
|
+
media: media.endpoints?.media ?? MAPO_MEDIA_DEFAULTS.endpoints.media,
|
|
147
|
+
folders:
|
|
148
|
+
media.endpoints?.folders ?? MAPO_MEDIA_DEFAULTS.endpoints.folders,
|
|
149
|
+
},
|
|
150
|
+
maxImageSize: media.maxImageSize ?? MAPO_MEDIA_DEFAULTS.maxImageSize,
|
|
151
|
+
maxVideoSize: media.maxVideoSize ?? MAPO_MEDIA_DEFAULTS.maxVideoSize,
|
|
152
|
+
maxDefaultSize:
|
|
153
|
+
media.maxDefaultSize ?? MAPO_MEDIA_DEFAULTS.maxDefaultSize,
|
|
154
|
+
permissionsModel:
|
|
155
|
+
media.permissionsModel ?? MAPO_MEDIA_DEFAULTS.permissionsModel,
|
|
156
|
+
};
|
|
157
|
+
|
|
88
158
|
const components = [
|
|
159
|
+
// ─── Shell / Layout ───────────────────────────────────────────────────
|
|
89
160
|
"MapoSnackBar",
|
|
90
161
|
"MapoConfirmDialog",
|
|
91
162
|
"MapoLogin",
|
|
@@ -96,6 +167,7 @@ export default defineNuxtModule<MapoUikitOptions>({
|
|
|
96
167
|
"MapoLogoutButton",
|
|
97
168
|
"MapoSidebarProfile",
|
|
98
169
|
"MapoTopbar",
|
|
170
|
+
// ─── CRUD / Detail / List ─────────────────────────────────────────────
|
|
99
171
|
"MapoDetail",
|
|
100
172
|
"MapoDetailLangSwitch",
|
|
101
173
|
"MapoList",
|
|
@@ -105,6 +177,15 @@ export default defineNuxtModule<MapoUikitOptions>({
|
|
|
105
177
|
"MapoListActions",
|
|
106
178
|
"MapoListQuickEdit",
|
|
107
179
|
"MapoListTable",
|
|
180
|
+
// ─── Media ───────────────────────────────────────────────────────────
|
|
181
|
+
"MapoDropArea",
|
|
182
|
+
"MapoMediaBreadcrumbs",
|
|
183
|
+
"MapoMediaFolders",
|
|
184
|
+
"MapoMediaGallery",
|
|
185
|
+
"MapoMediaFileChanger",
|
|
186
|
+
"MapoMediaEditor",
|
|
187
|
+
"MapoMediaUploader",
|
|
188
|
+
"MapoMediaManager",
|
|
108
189
|
];
|
|
109
190
|
|
|
110
191
|
for (const name of components) {
|
|
@@ -114,6 +195,19 @@ export default defineNuxtModule<MapoUikitOptions>({
|
|
|
114
195
|
});
|
|
115
196
|
}
|
|
116
197
|
|
|
198
|
+
// Registered as `global` so they survive runtime lookup from *another*
|
|
199
|
+
// package: the media fields in @mapomodule/form resolve the dialog by name
|
|
200
|
+
// (see useMediaManager) and render the preview in their templates. Nuxt's
|
|
201
|
+
// build-time auto-import only covers templates it scans, so a non-global
|
|
202
|
+
// registration resolves to nothing once the caller lives outside uikit.
|
|
203
|
+
for (const name of ["MapoMediaManagerDialog", "MapoMediaPreview"]) {
|
|
204
|
+
addComponent({
|
|
205
|
+
name,
|
|
206
|
+
global: true,
|
|
207
|
+
filePath: resolver.resolve(`./runtime/components/${name}.vue`),
|
|
208
|
+
});
|
|
209
|
+
}
|
|
210
|
+
|
|
117
211
|
addLayout(
|
|
118
212
|
{ src: resolver.resolve("./runtime/layouts/default.vue") },
|
|
119
213
|
"mapo-default",
|
|
@@ -139,6 +233,25 @@ export default defineNuxtModule<MapoUikitOptions>({
|
|
|
139
233
|
);
|
|
140
234
|
});
|
|
141
235
|
|
|
236
|
+
// NOTE: the `media` / `media-m2m` / `enhanced-media` field components live in
|
|
237
|
+
// @mapomodule/form with every other field type and are registered in its
|
|
238
|
+
// default registry. They resolve the picker dialog below at runtime.
|
|
239
|
+
|
|
240
|
+
// Plugin: provide the default $mapoMediaAdapter. Integrations register their
|
|
241
|
+
// own plugin ordered after this one to override request/response transforms.
|
|
242
|
+
addPlugin({
|
|
243
|
+
src: resolver.resolve("./runtime/plugins/media-adapter"),
|
|
244
|
+
order: 5,
|
|
245
|
+
});
|
|
246
|
+
|
|
247
|
+
// Auto-import useMediaStore so consumers can use it without explicit imports
|
|
248
|
+
addImports([
|
|
249
|
+
{
|
|
250
|
+
name: "useMediaStore",
|
|
251
|
+
from: resolver.resolve("./runtime/stores/media"),
|
|
252
|
+
},
|
|
253
|
+
]);
|
|
254
|
+
|
|
142
255
|
// MapoOverride* system: if the consuming app has a `mapooverride/` directory
|
|
143
256
|
// inside its srcDir, any .vue file named like a Mapo component will replace it
|
|
144
257
|
// at build time. Convention: MapoTopbar.vue overrides MapoTopbar, etc.
|