@conduction/nextcloud-vue 2.106.0 → 2.107.0

package/dist/esm/components/CnDashboardPage/CnDashboardPage.vue.js

@@ -2,7 +2,7 @@ import script from './CnDashboardPage.vue2.js';
 import { render } from './CnDashboardPage.vue3.js';
 
 script.render = render;
-script.__scopeId = "data-v-61decc06";
+script.__scopeId = "data-v-6991cea0";
 const __sfc_main = script;
 
 export { __sfc_main as default };

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

@@ -25,6 +25,7 @@ import __sfc_main$i from '../CnWidgetGrid/CnWidgetIcon.vue.js';
 import __sfc_main$8 from '../CnWidgetRefItem/CnWidgetRefItem.vue.js';
 import __sfc_main$4 from '../CnWidgetRenderer/CnWidgetRenderer.vue.js';
 import __sfc_main$3 from '../CnWidgetWrapper/CnWidgetWrapper.vue.js';
+import { fetchEndpointSource } from '../../composables/useEndpointSource.js';
 import { useIntegrationRegistry } from '../../composables/useIntegrationRegistry.js';
 import { normalizeLook } from '../../composables/useLook.js';
 import { pageViews } from '../../mixins/pageViews.js';
@@ -32,6 +33,7 @@ import { mergeUserLayout, resolveUserLayoutApi } from '../../store/plugins/dashb
 import { isAppInstalled } from '../../utils/appInstalled.js';
 import { contentHeaderLink } from '../../utils/contentHeaderLink.js';
 import { pickDeclaredProps } from '../../utils/declaredProps.js';
+import { readPath } from '../../utils/readPath.js';
 import { userLocale } from '../../utils/userLocale.js';
 import { isWorkspaceCondition, evaluateWorkspaceCondition, readVisibleWhenValue, compareVisibleWhen } from '../../utils/visibleWhen.js';
 import { canonicalWidgetType } from '../../utils/widgetTypeAliases.js';
@@ -164,6 +166,32 @@ const CHART_PROP_KEYS = [
  * }]
  * ```
  */
+
+/**
+ * One row of a page filter's `optionsFrom` as a `{ value, label }` option:
+ * `valueField` (default `id`, else the OpenRegister uuid) and `labelField`
+ * (default `title`, else `name`, else the value). Null for a row without a
+ * value.
+ *
+ * @param {unknown} row The row.
+ * @param {{valueField?: string, labelField?: string}} from The `optionsFrom` block.
+ * @return {{value: (string|number), label: string}|null}
+ */
+function pageFilterOptionOf(row, from) {
+	if (row === null || row === undefined) {
+		return null
+	}
+	if (typeof row !== 'object') {
+		return { value: row, label: String(row) }
+	}
+	const value = from.valueField ? readPath(row, from.valueField) : (row.id ?? row['@self']?.id ?? row.uuid);
+	if (value === null || value === undefined || value === '') {
+		return null
+	}
+	const label = from.labelField ? readPath(row, from.labelField) : (row.title || row.name);
+	return { value, label: label === null || label === undefined || label === '' ? String(value) : String(label) }
+}
+
 var script = {
 	name: 'CnDashboardPage',
 
@@ -702,10 +730,16 @@ var script = {
 		 * group on the header's description line, after the period group
 		 * (DqProcesanalyse "Gemiddeld | Mediaan"). An endpoint widget can read
 		 * the value in its `responsePath` too (`phaseDays.@workspace.measure`).
-		 * Empty (the default) renders no controls and leaves the context
-		 * untouched.
+		 * `optionsFrom` reads the options instead of listing them: `{ url,
+		 * params?, responsePath?, valueField?, labelField? }` from an app
+		 * endpoint, or `{ register, schema, filter?, valueField?, labelField? }`
+		 * from OpenRegister objects (value `id`, label `title` or `name` by
+		 * default; tokens resolve). `clearable: true` lets the reader clear the
+		 * select back to "all" (`placeholder`, e.g. "All case types"), which
+		 * writes null and seeds nothing. Empty (the default) renders no
+		 * controls and leaves the context untouched.
 		 *
-		 * @type {Array<{key: string, label?: string, type?: string, control?: ('select'|'segmented'), placement?: ('row'|'description'), options: Array<{value: (string|number), label: string}>, default?: (string|number)}>}
+		 * @type {Array<{key: string, label?: string, type?: string, control?: ('select'|'segmented'), placement?: ('row'|'description'), options?: Array<{value: (string|number), label: string}>, optionsFrom?: object, clearable?: boolean, placeholder?: string, default?: (string|number)}>}
 		 */
 		pageFilters: {
 			type: Array,
@@ -968,6 +1002,10 @@ var script = {
 
 	data() {
 		return {
+			/** Options read through a page filter's `optionsFrom`, by filter key. */
+			pageFilterFetched: {},
+			/** Whether a page filter's `optionsFrom` read is in flight, by filter key. */
+			pageFilterLoading: {},
 			isEditing: false,
 			/**
 			 * This user's arranged layout, when `userLayout` is on.
@@ -1827,6 +1865,7 @@ var script = {
 		this.pushAiContext();
 		this.initDateRange();
 		this.initPageFilters();
+		this.loadPageFilterOptions();
 		this.evaluateWidgetConditions();
 		this.loadUserLayout();
 	},
@@ -1856,7 +1895,7 @@ var script = {
 				if (this.workspaceContext[pf.key] !== undefined) {
 					continue
 				}
-				const fallback = (pf.options && pf.options.length) ? pf.options[0].value : undefined;
+				const fallback = (pf.options && pf.options.length && pf.clearable !== true) ? pf.options[0].value : undefined;
 				const value = pf.default !== undefined ? pf.default : fallback;
 				if (value !== undefined) {
 					this.workspaceContext[pf.key] = value;
@@ -1888,7 +1927,45 @@ var script = {
 		 * @return {Array<{value: (string|number), label: string}>}
 		 */
 		pageFilterSegments(pf) {
-			return (pf.options || []).map((o) => ({ value: o.value, label: o.label ? this.effectiveTranslate(o.label) : String(o.value) }))
+			const options = Array.isArray(pf.options) ? pf.options : (this.pageFilterFetched[pf.key] || []);
+			return options.map((o) => ({ value: o.value, label: o.label ? this.effectiveTranslate(o.label) : String(o.value) }))
+		},
+
+		/**
+		 * Read the options of every page filter with `optionsFrom`, then seed
+		 * a filter that is not clearable with its first option when it has no
+		 * value yet.
+		 *
+		 * @spec openspec/changes/page-filter-options-from/specs/dashboard-page/spec.md#requirement-a-page-filter-can-read-its-options
+		 * @return {Promise<void>}
+		 */
+		async loadPageFilterOptions() {
+			const ctx = { workspace: this.workspaceContext || {} };
+			await Promise.all((this.pageFilters || [])
+				.filter((pf) => pf && pf.key && !Array.isArray(pf.options) && pf.optionsFrom && typeof pf.optionsFrom === 'object')
+				.map(async (pf) => {
+					const from = pf.optionsFrom;
+					const source = from.register && from.schema
+						? { url: `/apps/openregister/api/objects/${from.register}/${from.schema}`, params: { _limit: 200, ...(from.filter || {}) }, responsePath: 'results' }
+						: { url: from.url, params: from.params, responsePath: from.responsePath };
+					if (!source.url) {
+						return
+					}
+					this.pageFilterLoading = { ...this.pageFilterLoading, [pf.key]: true };
+					let rows;
+					try {
+						const data = await fetchEndpointSource(source, ctx, { fresh: true });
+						rows = Array.isArray(data) ? data : [];
+					} catch {
+						rows = [];
+					}
+					const options = rows.map((row) => pageFilterOptionOf(row, from)).filter(Boolean);
+					this.pageFilterFetched = { ...this.pageFilterFetched, [pf.key]: options };
+					this.pageFilterLoading = { ...this.pageFilterLoading, [pf.key]: false };
+					if (pf.clearable !== true && pf.default === undefined && this.workspaceContext[pf.key] === undefined && options.length > 0) {
+						this.workspaceContext[pf.key] = options[0].value;
+					}
+				}));
 		},
 
 		/**
@@ -1903,7 +1980,7 @@ var script = {
 			if (!pf || !pf.key) {
 				return
 			}
-			const value = option && typeof option === 'object' ? option.value : option;
+			const value = option && typeof option === 'object' ? option.value : (option ?? null);
 			this.workspaceContext[pf.key] = value;
 			/**
 			 * @event page-filter-change Emitted when a page-level filter selection changes.