@conduction/nextcloud-vue 2.147.0 → 2.148.0

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

@@ -1704,6 +1704,12 @@ var script = {
 		 * browser session. A refusal keeps the record closed. `null` (the
 		 * default) asks nothing.
 		 *
+		 * `checkUrl` (GET, `{objectId}` filled in) is asked first: an answer
+		 * `{ required: false }` opens the record without the dialog (the app
+		 * recorded the purpose itself, as for the case's own handler); any
+		 * other answer, or a failure, shows the dialog. An option's `hint`
+		 * is a line under it saying what choosing it does besides recording it.
+		 *
 		 * @spec openspec/changes/detail-access-purpose/specs/detail-access-purpose/spec.md#requirement-a-detail-page-can-ask-for-a-purpose-before-it-opens
 		 * @type {object|null}
 		 */
@@ -2022,6 +2028,10 @@ var script = {
 			accessPurposeGranted: readGrantedPurposes(),
 			/** Whether the purpose dialog is open; closing it without a purpose keeps the record closed. */
 			accessPurposeAsking: true,
+			/** Whether `accessPurpose.checkUrl` is being asked for the record in view. */
+			accessPurposeChecking: false,
+			/** The record the check last answered for, so it is asked once per record. */
+			accessPurposeCheckedKey: '',
 			/** Whether a purpose is being recorded. */
 			accessPurposeBusy: false,
 			/** Why the last purpose was refused. */
@@ -2738,7 +2748,11 @@ var script = {
 			const options = Array.isArray(this.accessPurpose?.options) ? this.accessPurpose.options : [];
 			return options
 				.filter((option) => option && typeof option.value === 'string' && option.value !== '')
-				.map((option) => ({ value: option.value, label: this.cnTranslate(option.label || option.value) }))
+				.map((option) => ({
+					value: option.value,
+					label: this.cnTranslate(option.label || option.value),
+					...(typeof option.hint === 'string' && option.hint !== '' ? { hint: this.cnTranslate(option.hint) } : {}),
+				}))
 		},
 
 		/**
@@ -4441,6 +4455,17 @@ var script = {
 			this.accessPurposeError = '';
 		},
 
+		/** Once the page knows the record asks a purpose, the app is asked first whether it must (`checkUrl`). */
+		accessPurposeRequired: {
+			handler(required) {
+				if (required && this.contentWithheld) {
+					this.checkAccessPurpose();
+				}
+			},
+
+			immediate: true,
+		},
+
 		// Deep, like `sidebarTabs` / `sidebarProps` below: the manifest editors
 		// mutate `page.config.sidebar` IN PLACE, so the reference CnPageRenderer
 		// forwards never changes. A shallow watcher missed every such edit —
@@ -4698,6 +4723,50 @@ var script = {
 		 * @param {{purpose: string, note: string}} answer The chosen purpose.
 		 * @return {Promise<void>}
 		 */
+		/**
+		 * Ask the app whether the reader must state a purpose for this record
+		 * (`accessPurpose.checkUrl`); `{ required: false }` opens it at once.
+		 *
+		 * @spec openspec/changes/detail-access-purpose/specs/detail-access-purpose/spec.md#requirement-a-detail-page-can-ask-for-a-purpose-before-it-opens
+		 * @return {Promise<void>}
+		 */
+		async checkAccessPurpose() {
+			const key = this.accessPurposeKey;
+			const url = String(this.accessPurpose?.checkUrl || '').replace(/\{objectId\}/g, encodeURIComponent(String(this.objectId || '')));
+			if (url === '' || this.accessPurposeCheckedKey === key) {
+				return
+			}
+			this.accessPurposeCheckedKey = key;
+			this.accessPurposeChecking = true;
+			try {
+				const { default: axios } = await import('@nextcloud/axios');
+				const { data } = await axios.get(prefixUrl(url));
+				if (data && data.required === false && this.accessPurposeKey === key) {
+					this.grantAccessPurpose(key);
+				}
+			} catch {
+				// The check is a shortcut: without an answer the reader is asked as before.
+			} finally {
+				this.accessPurposeChecking = false;
+			}
+		},
+
+		/**
+		 * Open the record and remember for this browser session that its
+		 * purpose is recorded.
+		 *
+		 * @param {string} key The record's session key.
+		 * @return {void}
+		 */
+		grantAccessPurpose(key) {
+			this.accessPurposeGranted = [...new Set([...this.accessPurposeGranted, key])];
+			try {
+				window.sessionStorage.setItem(ACCESS_PURPOSE_SESSION_KEY, JSON.stringify(this.accessPurposeGranted));
+			} catch {
+				// Without session storage the purpose is asked again on the next visit.
+			}
+		},
+
 		async recordAccessPurpose(answer) {
 			const url = String(this.accessPurpose?.url || '').replace(/\{objectId\}/g, encodeURIComponent(String(this.objectId || '')));
 			if (url === '') {
@@ -4709,13 +4778,7 @@ var script = {
 			try {
 				const { default: axios } = await import('@nextcloud/axios');
 				await axios.post(prefixUrl(url), { purpose: answer.purpose, note: answer.note });
-				const key = this.accessPurposeKey;
-				this.accessPurposeGranted = [...new Set([...this.accessPurposeGranted, key])];
-				try {
-					window.sessionStorage.setItem(ACCESS_PURPOSE_SESSION_KEY, JSON.stringify(this.accessPurposeGranted));
-				} catch {
-					// Without session storage the purpose is asked again on the next visit.
-				}
+				this.grantAccessPurpose(this.accessPurposeKey);
 			} catch (error) {
 				const data = error?.response?.data;
 				this.accessPurposeError = (data && (data.message || data.error)) || translate('nextcloud-vue', 'Your purpose could not be recorded, so the record stays closed.');