@conduction/nextcloud-vue 2.62.0 → 2.64.0

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

@@ -1,11 +1,13 @@
 import { getCurrentUser } from '@nextcloud/auth';
 import axios__default from '@nextcloud/axios';
 import { loadState } from '@nextcloud/initial-state';
+import { translate } from '@nextcloud/l10n';
 import { generateUrl } from '@nextcloud/router';
 import { NcAppContent, NcAppSettingsDialog, NcAppSettingsSection, NcButton, NcContent, NcEmptyContent, NcLoadingIcon, NcNoteCard } from '@nextcloud/vue';
 import { shallowRef, watch, computed, reactive } from 'vue';
 import DatabaseSearchOutline from 'vue-material-design-icons/DatabaseSearchOutline.vue';
 import OpenInNew from 'vue-material-design-icons/OpenInNew.vue';
+import Play from 'vue-material-design-icons/Play.vue';
 import Restart from 'vue-material-design-icons/Restart.vue';
 import __sfc_main$5 from '../CnAiCompanion/CnAiCompanion.vue.js';
 import __sfc_main$1 from '../CnAppLoading/CnAppLoading.vue.js';
@@ -29,13 +31,14 @@ import { useSetupStatus } from '../../composables/useSetupStatus.js';
 import { useSupportDialog } from '../../composables/useSupportDialog.js';
 import { provideTenantContext } from '../../composables/useTenantContext.js';
 import { useUserPreferences } from '../../composables/useUserPreferences.js';
-import { useWalkthrough, readLocalWalkthroughSeenVersion, loadWalkthroughSeenVersion, normaliseSeenVersion, persistWalkthroughSeenVersion } from '../../composables/useWalkthrough.js';
+import { useWalkthrough, readLocalWalkthroughSeenVersion, readLocalWalkthroughProgress, loadWalkthroughSeenVersion, loadWalkthroughProgress, normaliseSeenVersion, persistWalkthroughSeenVersion, persistWalkthroughProgress } from '../../composables/useWalkthrough.js';
 import { RegistryKindError } from '../../errors/RegistryKindError.js';
 import { isAppInstalled } from '../../utils/appInstalled.js';
 import { BUILT_IN_FORMATTERS } from '../../utils/builtInFormatters.js';
 import { resolveForge, DEFAULT_FORGE } from '../../utils/forge.js';
 import { BUILT_IN_KB_PROVIDERS } from '../../utils/kbSearchProviders.js';
 import { installModalStack, uninstallModalStack } from '../../utils/modalStack.js';
+import { resolveFilterTokens } from '../../utils/resolveFilterTokens.js';
 import { passesContextPredicates } from '../../utils/visibleIfContext.js';
 import { useObjectStore } from '../../store/useObjectStore.js';
 
@@ -106,6 +109,7 @@ var script = {
 		NcNoteCard,
 		DatabaseSearchOutline,
 		OpenInNew,
+		Play,
 		Restart,
 		CnAppNav: __sfc_main,
 		CnAppLoading: __sfc_main$1,
@@ -385,6 +389,13 @@ var script = {
 			 * the counts.
 			 */
 			cnMenuCounts: this.cnMenuCounts,
+			/**
+			 * Reactive `{ [menuItemId]: number }` totals for menu entries
+			 * whose `count` is an object (`{ register, schema, filter? }`),
+			 * populated by `_hydrateMenuItemCounts()`. Read by
+			 * `CnAppNav.resolveCount()`.
+			 */
+			cnMenuItemCounts: this.cnMenuItemCounts,
 		}
 	},
 
@@ -528,6 +539,19 @@ var script = {
 			required: true,
 		},
 
+		/**
+		 * Render no app navigation at all: neither the default CnAppNav nor
+		 * the `#menu` slot, so the content starts at the left edge (a start
+		 * page without a menu). Off by default; the navigation renders as it
+		 * always has.
+		 *
+		 * @spec openspec/changes/zuiddrecht-pixel-gaps/specs/zuiddrecht-pixel-gaps/spec.md#requirement-an-app-root-can-hide-its-menu
+		 */
+		hideMenu: {
+			type: Boolean,
+			default: false,
+		},
+
 		/**
 		 * Human-readable name shown in the Nextcloud top bar. When set it
 		 * overrides the technical `appId` so a virtual app shows its own name
@@ -1043,6 +1067,13 @@ var script = {
 			 * picked up by CnAppNav's reactive render.
 			 */
 			cnMenuCounts: reactive({}),
+			/**
+			 * Reactive `{ [menuItemId]: number }` map of filtered totals, one
+			 * per menu entry whose `count` is an object. Provided to
+			 * descendants as `cnMenuItemCounts`. Populated by
+			 * `_hydrateMenuItemCounts()` at mount.
+			 */
+			cnMenuItemCounts: reactive({}),
 			/**
 			 * Open state of the host NcAppSettingsDialog. Toggled
 			 * to `true` by the provided `cnOpenUserSettings()`
@@ -1133,6 +1164,15 @@ var script = {
 			 * @type {string}
 			 */
 			walkthroughSeenVersionValue: readLocalWalkthroughSeenVersion(this.appId),
+			/**
+			 * Where the user is in an unfinished tour (`{ tourId, stepId,
+			 * index, version }`), or null. Seeded from the local mirror, then
+			 * replaced by the per-user `<completionConfigKey>-progress`
+			 * preference. The tour resumes at this step on the next visit.
+			 *
+			 * @type {object|null}
+			 */
+			walkthroughProgressValue: readLocalWalkthroughProgress(this.appId),
 			/**
 			 * Whether `walkthroughSeenVersionValue` is settled. Starts `true`
 			 * when the manifest declares no `completionConfigKey` (the local
@@ -1886,13 +1926,15 @@ var script = {
 			try {
 				const p = new URLSearchParams(window.location.search);
 				const tourId = p.get('cn_resume_tour');
-				if (!tourId) {
-					return null
+				if (tourId) {
+					return { tourId, stepId: p.get('cn_resume_step') || '' }
 				}
-				return { tourId, stepId: p.get('cn_resume_step') || '' }
 			} catch {
-				return null
+				// No URL token; fall through to the remembered progress.
 			}
+			// An unfinished tour continues at the step the user reached.
+			const progress = this.walkthroughProgressValue;
+			return progress ? { tourId: progress.tourId, stepId: progress.stepId } : null
 		},
 
 		phase() {
@@ -2135,6 +2177,24 @@ var script = {
 			return this.translate('Restart walkthrough')
 		},
 
+		/**
+		 * Label for continuing an unfinished tour at the remembered step.
+		 *
+		 * @return {string}
+		 */
+		continueWalkthroughLabel() {
+			return translate('nextcloud-vue', 'Continue where you left off')
+		},
+
+		/**
+		 * Label for restarting an unfinished tour from the first step.
+		 *
+		 * @return {string}
+		 */
+		startOverWalkthroughLabel() {
+			return translate('nextcloud-vue', 'Start over')
+		},
+
 		/**
 		 * Resolve the active modal's Vue component from the registry.
 		 * Returns null when no modal is open or the key no longer resolves.
@@ -2232,6 +2292,7 @@ var script = {
 			this._validateRegistry();
 			this._warnCustomComponentsDeprecation();
 			this._hydrateMenuCounts();
+			this._hydrateMenuItemCounts();
 			return
 		}
 
@@ -2260,6 +2321,7 @@ var script = {
 		this._validateRegistry();
 		this._warnCustomComponentsDeprecation();
 		this._hydrateMenuCounts();
+		this._hydrateMenuItemCounts();
 	},
 
 	beforeUnmount() {
@@ -2638,10 +2700,12 @@ var script = {
 				return
 			}
 			try {
-				this.walkthroughSeenVersionValue = await loadWalkthroughSeenVersion(
-					this.appId,
-					this.walkthroughConfigKey,
-				);
+				const [seen, progress] = await Promise.all([
+					loadWalkthroughSeenVersion(this.appId, this.walkthroughConfigKey),
+					loadWalkthroughProgress(this.appId, this.walkthroughConfigKey),
+				]);
+				this.walkthroughSeenVersionValue = seen;
+				this.walkthroughProgressValue = progress;
 			} finally {
 				this.walkthroughSeenResolved = true;
 			}
@@ -2665,12 +2729,68 @@ var script = {
 			// Fire-and-forget: the loader never rejects and the local mirror is
 			// already written, so a failed PUT must not surface as an error.
 			persistWalkthroughSeenVersion(this.appId, this.walkthroughConfigKey, v);
+			// A finished or skipped tour has nothing to continue.
+			if (this.walkthroughProgressValue) {
+				this.walkthroughProgressValue = null;
+				persistWalkthroughProgress(this.appId, this.walkthroughConfigKey, null);
+			}
 			/**
 			 * @event walkthrough-complete Emitted when the walkthrough finishes or is dismissed.
 			 */
 			this.$emit('walkthrough-complete');
 		},
 
+		/**
+		 * Remember where the user is in the tour, so a reload or a restart
+		 * entry continues there (local mirror + per-user preference).
+		 *
+		 * @spec openspec/changes/walkthrough-advance-pause-resume/specs/cn-walkthrough/spec.md
+		 * @param {object} progress `{ tourId, stepId, index }` from CnWalkthrough.
+		 * @return {void}
+		 */
+		onWalkthroughProgress(progress) {
+			if (!progress || !progress.tourId) {
+				return
+			}
+			// The first step of a fresh tour is where a restart lands anyway,
+			// so it costs no request.
+			if (progress.index === 0 && !this.walkthroughProgressValue) {
+				return
+			}
+			const value = {
+				tourId: progress.tourId,
+				stepId: progress.stepId || '',
+				index: progress.index || 0,
+				version: String((this.manifest && this.manifest.version) || ''),
+			};
+			this.walkthroughProgressValue = value;
+			persistWalkthroughProgress(this.appId, this.walkthroughConfigKey, value);
+		},
+
+		/**
+		 * Continue an unfinished tour from the user-settings dialog: show a
+		 * paused tour again, or start the remembered tour at its step.
+		 *
+		 * @spec openspec/changes/walkthrough-advance-pause-resume/specs/cn-walkthrough/spec.md
+		 * @return {void}
+		 */
+		continueWalkthroughFromSettings() {
+			this.userSettingsOpen = false;
+			if (!this.walkthroughEnabled) {
+				return
+			}
+			setTimeout(() => {
+				const wt = useWalkthrough(this.appId, this.manifest);
+				if (wt.resumePaused()) {
+					return
+				}
+				const progress = this.walkthroughProgressValue;
+				if (progress) {
+					wt.resumeAt(progress.tourId, progress.stepId);
+				}
+			}, 50);
+		},
+
 		/**
 		 * Replay the product tour from the user-settings dialog. Closes the
 		 * dialog first, then restarts the first declared tour on the next tick
@@ -2858,6 +2978,63 @@ var script = {
 			});
 		},
 
+		/**
+		 * Fetch the total of every menu entry (top level and children) whose
+		 * `count` is an object `{ register, schema, filter? }`: one
+		 * `GET /api/objects/{register}/{schema}?_limit=1` per entry with the
+		 * filter's tokens (`@me`, `@today`, ...) resolved at fetch time, the
+		 * response `total` written to `cnMenuItemCounts[item.id]`. The
+		 * request goes straight through axios rather than the object store,
+		 * so the index page's whole-schema total in the store is left alone.
+		 * Failures leave the badge unrendered.
+		 *
+		 * @spec openspec/changes/zuiddrecht-pixel-gaps/specs/zuiddrecht-pixel-gaps/spec.md#requirement-a-menu-entry-counts-a-filtered-list
+		 * @return {void}
+		 * @private
+		 */
+		_hydrateMenuItemCounts() {
+			const collect = (items) => {
+				const out = [];
+				for (const item of items ?? []) {
+					const count = item?.count;
+					if (count && typeof count === 'object' && typeof item.id === 'string' && count.register && count.schema) {
+						out.push(item);
+					}
+					if (Array.isArray(item?.children)) {
+						out.push(...collect(item.children));
+					}
+				}
+				return out
+			};
+			for (const item of collect(this.manifest?.menu)) {
+				this._fetchMenuItemCount(item);
+			}
+		},
+
+		/**
+		 * One filtered-count request for a menu entry; see
+		 * `_hydrateMenuItemCounts`.
+		 *
+		 * @spec openspec/changes/zuiddrecht-pixel-gaps/specs/zuiddrecht-pixel-gaps/spec.md#requirement-a-menu-entry-counts-a-filtered-list
+		 * @param {{ id: string, count: { register: string, schema: string, filter?: object } }} item The menu entry.
+		 * @return {Promise<void>}
+		 * @private
+		 */
+		async _fetchMenuItemCount(item) {
+			try {
+				const { register, schema, filter } = item.count;
+				const resolved = resolveFilterTokens(filter && typeof filter === 'object' ? filter : {}, {});
+				const url = generateUrl(`/apps/openregister/api/objects/${encodeURIComponent(register)}/${encodeURIComponent(schema)}`);
+				const { data } = await axios__default.get(url, { params: { _limit: 1, ...resolved } });
+				const total = data?.total;
+				if (typeof total === 'number' && total >= 0) {
+					this.cnMenuItemCounts[item.id] = total;
+				}
+			} catch {
+				// Non-fatal: the badge stays unrendered.
+			}
+		},
+
 		/**
 		 * Hydrate all menu counts with a single `POST /api/objects/counts`
 		 * (OpenRegister batched-counts endpoint). Distributes each returned