@conduction/nextcloud-vue 2.106.0 → 2.107.0

package/dist/esm/components/CnAppRoot/CnAppRoot.vue2.js

@@ -42,6 +42,7 @@ import { RegistryKindError } from '../../errors/RegistryKindError.js';
 import { isAppInstalled } from '../../utils/appInstalled.js';
 import { appShownName } from '../../utils/appShownName.js';
 import { BUILT_IN_FORMATTERS } from '../../utils/builtInFormatters.js';
+import { resolveModalEntry } from '../../utils/builtInModals.js';
 import { reportDiagnostic, clearReportedDiagnostics, addDiagnosticsListener } from '../../utils/diagnostics.js';
 import { resolveForge, DEFAULT_FORGE } from '../../utils/forge.js';
 import { BUILT_IN_KB_PROVIDERS } from '../../utils/kbSearchProviders.js';
@@ -50,6 +51,7 @@ import { installModalStack, uninstallModalStack } from '../../utils/modalStack.j
 import { OBJECTS_CHANGED_EVENT } from '../../utils/objectSignals.js';
 import { resolveBrand } from '../../utils/resolveBrand.js';
 import { resolveFilterTokens } from '../../utils/resolveFilterTokens.js';
+import { withSavedViewMenu, normalizeSavedViewMenu, SAVED_VIEW_MENU_KEY, toggleSavedViewMenuEntry, syncSavedViewMenu } from '../../utils/savedViewMenu.js';
 import { passesContextPredicates } from '../../utils/visibleIfContext.js';
 import { useObjectStore } from '../../store/useObjectStore.js';
 
@@ -186,6 +188,10 @@ var script = {
 				return self.userPreferences
 			},
 
+			// The saved views this user added to the menu, and the way to
+			// change them, for an index page's sidebar.
+			cnSavedViewMenu: self.savedViewMenu,
+
 			// The same manifest as a REF. The getter above is NOT enough on its
 			// own: Options-API `inject` resolves a provided value once, at the
 			// descendant's creation, so a renderer created before edit mode gets
@@ -262,7 +268,7 @@ var script = {
 			 * @param {object} props Props forwarded to the modal component.
 			 */
 			cnOpenModal: (key, props = {}) => {
-				const entry = this.registry[key];
+				const entry = resolveModalEntry(this.registry, key);
 				if (!entry || entry.kind !== 'modal') {
 					// eslint-disable-next-line no-console
 					console.warn(`[CnAppRoot] cnOpenModal: "${key}" is not a registered modal (kind must be "modal").`);
@@ -1204,6 +1210,16 @@ var script = {
 	data() {
 		const willCheck = Array.isArray(this.requiresApps) && this.requiresApps.length > 0;
 		return {
+			// Saved views this user added to the menu (per-user preference).
+			// One object for the whole session, so the provide hands out a
+			// live reference: `entries` changes, the holder does not.
+			savedViewMenuLoaded: false,
+			savedViewMenu: {
+				entries: [],
+				toggle: (entry) => this.toggleSavedViewMenu(entry),
+				sync: (page, views) => this.syncSavedViewMenu(page, views),
+			},
+
 			// Nextcloud's own header, present on a server-rendered page; the
 			// brand block goes into it (CnBrandBar). Read once at creation so
 			// the navigation never draws a block that then moves.
@@ -1671,6 +1687,16 @@ var script = {
 			return groups.some((g) => owners.includes(g))
 		},
 
+		/**
+		 * Whether any page of the manifest offers saved views.
+		 *
+		 * @return {boolean}
+		 */
+		offersSavedViews() {
+			const pages = this.manifest && Array.isArray(this.manifest.pages) ? this.manifest.pages : [];
+			return pages.some((page) => page && page.config && page.config.allowSavedViews === true)
+		},
+
 		/**
 		 * The manifest the default `<CnAppNav>` renders — the editor's working
 		 * `source` while in-app editing, else the live `manifest` prop. Passed to
@@ -1702,6 +1728,12 @@ var script = {
 			if (this.manifestEditor && this.manifestEditor.editing.value && m && typeof m === 'object') {
 				return { ...m }
 			}
+			// An app that offers saved views ends its menu with the "My views"
+			// group: the user's pinned views, or one line saying how to add one.
+			// Any other app gets its live manifest by identity.
+			if (m && typeof m === 'object' && Array.isArray(m.menu) && (this.savedViewMenu.entries.length > 0 || this.offersSavedViews)) {
+				return { ...m, menu: withSavedViewMenu(m.menu, this.savedViewMenu.entries, { showEmpty: this.offersSavedViews }) }
+			}
 			return m
 		},
 
@@ -2539,12 +2571,24 @@ var script = {
 			if (!this.activeModalKey) {
 				return null
 			}
-			const entry = (this.registry || {})[this.activeModalKey];
+			const entry = resolveModalEntry(this.registry, this.activeModalKey);
 			return (entry && entry.component) ? entry.component : null
 		},
 	},
 
 	watch: {
+		// Only an app with a page that offers saved views reads the list,
+		// once, when such a page first appears in the manifest.
+		offersSavedViews: {
+			immediate: true,
+			handler(offers) {
+				if (offers && !this.savedViewMenuLoaded) {
+					this.savedViewMenuLoaded = true;
+					this.loadSavedViewMenu();
+				}
+			},
+		},
+
 		/**
 		 * Close a registry modal when the route changes.
 		 *
@@ -2686,6 +2730,62 @@ var script = {
 	},
 
 	methods: {
+		/**
+		 * Read the saved views this user added to the menu.
+		 *
+		 * @return {Promise<void>}
+		 * @spec openspec/changes/saved-views-manage-and-defaults/tasks.md#task-7
+		 */
+		async loadSavedViewMenu() {
+			const read = this.userPreferences && this.userPreferences.read;
+			if (typeof read !== 'function') {
+				return
+			}
+			try {
+				this.savedViewMenu.entries = normalizeSavedViewMenu(await read(SAVED_VIEW_MENU_KEY, []));
+			} catch {
+				// No menu entries; the views themselves are unaffected.
+			}
+		},
+
+		/**
+		 * Add a saved view to the menu, or remove it, and store the list.
+		 *
+		 * @param {{id: string, page: string, name: string}} entry The view.
+		 * @return {Promise<void>}
+		 * @spec openspec/changes/saved-views-manage-and-defaults/tasks.md#task-7
+		 */
+		async toggleSavedViewMenu(entry) {
+			this.savedViewMenu.entries = toggleSavedViewMenuEntry(this.savedViewMenu.entries, entry);
+			await this.writeSavedViewMenu();
+		},
+
+		/**
+		 * Bring one page's menu entries in line with the views it lists, and
+		 * store the list only when that changed something.
+		 *
+		 * @param {string} page The page's route name.
+		 * @param {Array<object>} views The views the page lists.
+		 * @return {Promise<void>}
+		 * @spec openspec/changes/saved-views-manage-and-defaults/tasks.md#task-7
+		 */
+		async syncSavedViewMenu(page, views) {
+			const next = syncSavedViewMenu(this.savedViewMenu.entries, page, views);
+			if (JSON.stringify(next) === JSON.stringify(this.savedViewMenu.entries)) {
+				return
+			}
+			this.savedViewMenu.entries = next;
+			await this.writeSavedViewMenu();
+		},
+
+		/** @return {Promise<void>} Store the list in the user's preferences. */
+		async writeSavedViewMenu() {
+			const write = this.userPreferences && this.userPreferences.write;
+			if (typeof write === 'function') {
+				await write(SAVED_VIEW_MENU_KEY, this.savedViewMenu.entries);
+			}
+		},
+
 		/** Listen for the host's `diagnostics` function while it is set; adds this root's page id. */
 		syncDiagnostics() {
 			if (this.removeDiagnostics) {