@conduction/nextcloud-vue 2.127.0 → 2.128.0

package/dist/esm/mixins/pageFilters.js

@@ -0,0 +1,142 @@
+import { isOptionsFrom, loadOptionsFrom } from '../utils/optionsFrom.js';
+import { generatedPageFilterOptions } from '../utils/periodOptions.js';
+
+/**
+ * SPDX-FileCopyrightText: 2026 Conduction B.V.
+ * SPDX-License-Identifier: EUPL-1.2
+ */
+
+
+/**
+ * Page-level filters (manifest `config.pageFilters`), shared by CnDashboardPage
+ * and CnDetailPage: seeding each filter's value, reading its options and
+ * writing a choice into the page's workspace context, where a widget reads it
+ * through `@page.<key>` / `@workspace.<key>`.
+ *
+ * The host provides `pageFilters` (the declared filters), `workspaceContext`
+ * (the reactive bag it provides as `cnWorkspaceContext`) and
+ * `effectiveTranslate` (the host app's translate).
+ *
+ * @spec openspec/changes/detail-page-filters/specs/detail-page/spec.md#requirement-a-detail-page-can-draw-page-filters-that-its-widgets-read
+ */
+const pageFilters = {
+	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: {},
+		}
+	},
+
+	methods: {
+		/**
+		 * Seed the reactive workspace context with each page filter's default
+		 * (its `default`, else the first option's value) so endpoint-bound
+		 * widgets have a value to interpolate on first render. Only writes keys
+		 * that aren't already present, so a value another widget set survives.
+		 *
+		 * @return {void}
+		 */
+		initPageFilters() {
+			for (const pf of this.pageFilters || []) {
+				if (!pf || !pf.key) {
+					continue
+				}
+				if (this.workspaceContext[pf.key] !== undefined) {
+					continue
+				}
+				const listed = Array.isArray(pf.options) ? pf.options : generatedPageFilterOptions(pf);
+				const fallback = (listed && listed.length && pf.clearable !== true) ? listed[0].value : undefined;
+				const value = pf.default !== undefined ? pf.default : fallback;
+				if (value !== undefined) {
+					this.workspaceContext[pf.key] = value;
+				}
+			}
+		},
+
+		/**
+		 * The currently-selected option object for a page filter's NcSelect
+		 * (matched by `value` against the workspace context), or null.
+		 *
+		 * @param {object} pf The page-filter descriptor.
+		 * @return {object|null}
+		 */
+		selectedPageFilterOption(pf) {
+			if (!pf || !pf.key) {
+				return null
+			}
+			const current = this.workspaceContext[pf.key];
+			return this.pageFilterSegments(pf).find((o) => o.value === current) || null
+		},
+
+		/**
+		 * A page filter's options, labels through the host translate: the
+		 * segments of a segmented filter and the options of a select.
+		 *
+		 * @spec openspec/changes/dashboard-board-termijnen/specs/dashboard-page/spec.md#requirement-a-page-filter-as-a-segmented-group-on-the-description-line
+		 * @param {object} pf The page-filter descriptor.
+		 * @return {Array<{value: (string|number), label: string}>}
+		 */
+		pageFilterSegments(pf) {
+			const options = Array.isArray(pf.options) ? pf.options : (generatedPageFilterOptions(pf) || 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;
+					if (!isOptionsFrom(from)) {
+						return
+					}
+					this.pageFilterLoading = { ...this.pageFilterLoading, [pf.key]: true };
+					let options;
+					try {
+						options = (await loadOptionsFrom(from, ctx)).map((o) => ({ value: o.id, label: o.label }));
+					} catch {
+						options = [];
+					}
+					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;
+					}
+				}));
+		},
+
+		/**
+		 * Write a page filter's new selection into the reactive workspace
+		 * context so every `@page.<key>` / `@workspace.<key>` token re-resolves.
+		 *
+		 * @param {object} pf The page-filter descriptor.
+		 * @param {object|null} option The chosen NcSelect option (`{ value, label }`).
+		 * @return {void}
+		 */
+		onPageFilterChange(pf, option) {
+			if (!pf || !pf.key) {
+				return
+			}
+			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.
+			 * @type {{ key: string, value: (string|number|null) }}
+			 */
+			this.$emit('page-filter-change', { key: pf.key, value });
+		},
+	},
+};
+
+export { pageFilters };
+//# sourceMappingURL=pageFilters.js.map

package/dist/esm/mixins/pageFilters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pageFilters.js","sources":["../../../src/mixins/pageFilters.js"],"sourcesContent":["/**\n * SPDX-FileCopyrightText: 2026 Conduction B.V.\n * SPDX-License-Identifier: EUPL-1.2\n */\n\nimport { isOptionsFrom, loadOptionsFrom } from '../utils/optionsFrom.js'\nimport { generatedPageFilterOptions } from '../utils/periodOptions.js'\n\n/**\n * Page-level filters (manifest `config.pageFilters`), shared by CnDashboardPage\n * and CnDetailPage: seeding each filter's value, reading its options and\n * writing a choice into the page's workspace context, where a widget reads it\n * through `@page.<key>` / `@workspace.<key>`.\n *\n * The host provides `pageFilters` (the declared filters), `workspaceContext`\n * (the reactive bag it provides as `cnWorkspaceContext`) and\n * `effectiveTranslate` (the host app's translate).\n *\n * @spec openspec/changes/detail-page-filters/specs/detail-page/spec.md#requirement-a-detail-page-can-draw-page-filters-that-its-widgets-read\n */\nexport const pageFilters = {\n\tdata() {\n\t\treturn {\n\t\t\t/** Options read through a page filter's `optionsFrom`, by filter key. */\n\t\t\tpageFilterFetched: {},\n\t\t\t/** Whether a page filter's `optionsFrom` read is in flight, by filter key. */\n\t\t\tpageFilterLoading: {},\n\t\t}\n\t},\n\n\tmethods: {\n\t\t/**\n\t\t * Seed the reactive workspace context with each page filter's default\n\t\t * (its `default`, else the first option's value) so endpoint-bound\n\t\t * widgets have a value to interpolate on first render. Only writes keys\n\t\t * that aren't already present, so a value another widget set survives.\n\t\t *\n\t\t * @return {void}\n\t\t */\n\t\tinitPageFilters() {\n\t\t\tfor (const pf of this.pageFilters || []) {\n\t\t\t\tif (!pf || !pf.key) {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tif (this.workspaceContext[pf.key] !== undefined) {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tconst listed = Array.isArray(pf.options) ? pf.options : generatedPageFilterOptions(pf)\n\t\t\t\tconst fallback = (listed && listed.length && pf.clearable !== true) ? listed[0].value : undefined\n\t\t\t\tconst value = pf.default !== undefined ? pf.default : fallback\n\t\t\t\tif (value !== undefined) {\n\t\t\t\t\tthis.workspaceContext[pf.key] = value\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\n\t\t/**\n\t\t * The currently-selected option object for a page filter's NcSelect\n\t\t * (matched by `value` against the workspace context), or null.\n\t\t *\n\t\t * @param {object} pf The page-filter descriptor.\n\t\t * @return {object|null}\n\t\t */\n\t\tselectedPageFilterOption(pf) {\n\t\t\tif (!pf || !pf.key) {\n\t\t\t\treturn null\n\t\t\t}\n\t\t\tconst current = this.workspaceContext[pf.key]\n\t\t\treturn this.pageFilterSegments(pf).find((o) => o.value === current) || null\n\t\t},\n\n\t\t/**\n\t\t * A page filter's options, labels through the host translate: the\n\t\t * segments of a segmented filter and the options of a select.\n\t\t *\n\t\t * @spec openspec/changes/dashboard-board-termijnen/specs/dashboard-page/spec.md#requirement-a-page-filter-as-a-segmented-group-on-the-description-line\n\t\t * @param {object} pf The page-filter descriptor.\n\t\t * @return {Array<{value: (string|number), label: string}>}\n\t\t */\n\t\tpageFilterSegments(pf) {\n\t\t\tconst options = Array.isArray(pf.options) ? pf.options : (generatedPageFilterOptions(pf) || this.pageFilterFetched[pf.key] || [])\n\t\t\treturn options.map((o) => ({ value: o.value, label: o.label ? this.effectiveTranslate(o.label) : String(o.value) }))\n\t\t},\n\n\t\t/**\n\t\t * Read the options of every page filter with `optionsFrom`, then seed\n\t\t * a filter that is not clearable with its first option when it has no\n\t\t * value yet.\n\t\t *\n\t\t * @spec openspec/changes/page-filter-options-from/specs/dashboard-page/spec.md#requirement-a-page-filter-can-read-its-options\n\t\t * @return {Promise<void>}\n\t\t */\n\t\tasync loadPageFilterOptions() {\n\t\t\tconst ctx = { workspace: this.workspaceContext || {} }\n\t\t\tawait Promise.all((this.pageFilters || [])\n\t\t\t\t.filter((pf) => pf && pf.key && !Array.isArray(pf.options) && pf.optionsFrom && typeof pf.optionsFrom === 'object')\n\t\t\t\t.map(async (pf) => {\n\t\t\t\t\tconst from = pf.optionsFrom\n\t\t\t\t\tif (!isOptionsFrom(from)) {\n\t\t\t\t\t\treturn\n\t\t\t\t\t}\n\t\t\t\t\tthis.pageFilterLoading = { ...this.pageFilterLoading, [pf.key]: true }\n\t\t\t\t\tlet options\n\t\t\t\t\ttry {\n\t\t\t\t\t\toptions = (await loadOptionsFrom(from, ctx)).map((o) => ({ value: o.id, label: o.label }))\n\t\t\t\t\t} catch {\n\t\t\t\t\t\toptions = []\n\t\t\t\t\t}\n\t\t\t\t\tthis.pageFilterFetched = { ...this.pageFilterFetched, [pf.key]: options }\n\t\t\t\t\tthis.pageFilterLoading = { ...this.pageFilterLoading, [pf.key]: false }\n\t\t\t\t\tif (pf.clearable !== true && pf.default === undefined && this.workspaceContext[pf.key] === undefined && options.length > 0) {\n\t\t\t\t\t\tthis.workspaceContext[pf.key] = options[0].value\n\t\t\t\t\t}\n\t\t\t\t}))\n\t\t},\n\n\t\t/**\n\t\t * Write a page filter's new selection into the reactive workspace\n\t\t * context so every `@page.<key>` / `@workspace.<key>` token re-resolves.\n\t\t *\n\t\t * @param {object} pf The page-filter descriptor.\n\t\t * @param {object|null} option The chosen NcSelect option (`{ value, label }`).\n\t\t * @return {void}\n\t\t */\n\t\tonPageFilterChange(pf, option) {\n\t\t\tif (!pf || !pf.key) {\n\t\t\t\treturn\n\t\t\t}\n\t\t\tconst value = option && typeof option === 'object' ? option.value : (option ?? null)\n\t\t\tthis.workspaceContext[pf.key] = value\n\t\t\t/**\n\t\t\t * @event page-filter-change Emitted when a page-level filter selection changes.\n\t\t\t * @type {{ key: string, value: (string|number|null) }}\n\t\t\t */\n\t\t\tthis.$emit('page-filter-change', { key: pf.key, value })\n\t\t},\n\t},\n}\n"],"names":[],"mappings":";;;AAAA;AACA;AACA;AACA;AACA;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,WAAW,GAAG;AAC3B,CAAC,IAAI,GAAG;AACR,EAAE,OAAO;AACT;AACA,GAAG,iBAAiB,EAAE,EAAE;AACxB;AACA,GAAG,iBAAiB,EAAE,EAAE;AACxB,GAAG;AACH,EAAE;AACF;AACA,CAAC,OAAO,EAAE;AACV;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,eAAe,GAAG;AACpB,GAAG,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,WAAW,IAAI,EAAE,EAAE;AAC5C,IAAI,IAAI,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE;AACxB,KAAK,QAAQ;AACb,KAAK;AACL,IAAI,IAAI,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;AACrD,KAAK,QAAQ;AACb,KAAK;AACL,IAAI,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,GAAG,0BAA0B,CAAC,EAAE,EAAC;AAC1F,IAAI,MAAM,QAAQ,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,SAAS,KAAK,IAAI,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,UAAS;AACrG,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC,OAAO,KAAK,SAAS,GAAG,EAAE,CAAC,OAAO,GAAG,SAAQ;AAClE,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE;AAC7B,KAAK,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,MAAK;AAC1C,KAAK;AACL,IAAI;AACJ,GAAG;AACH;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,wBAAwB,CAAC,EAAE,EAAE;AAC/B,GAAG,IAAI,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE;AACvB,IAAI,OAAO,IAAI;AACf,IAAI;AACJ,GAAG,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,GAAG,EAAC;AAChD,GAAG,OAAO,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK,OAAO,CAAC,IAAI,IAAI;AAC9E,GAAG;AACH;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,kBAAkB,CAAC,EAAE,EAAE;AACzB,GAAG,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,IAAI,0BAA0B,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,EAAC;AACpI,GAAG,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AACvH,GAAG;AACH;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,MAAM,qBAAqB,GAAG;AAChC,GAAG,MAAM,GAAG,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,gBAAgB,IAAI,EAAE,GAAE;AACzD,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE;AAC5C,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,WAAW,IAAI,OAAO,EAAE,CAAC,WAAW,KAAK,QAAQ,CAAC;AACvH,KAAK,GAAG,CAAC,OAAO,EAAE,KAAK;AACvB,KAAK,MAAM,IAAI,GAAG,EAAE,CAAC,YAAW;AAChC,KAAK,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE;AAC/B,MAAM,MAAM;AACZ,MAAM;AACN,KAAK,IAAI,CAAC,iBAAiB,GAAG,EAAE,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,GAAG,GAAG,IAAI,GAAE;AAC3E,KAAK,IAAI,QAAO;AAChB,KAAK,IAAI;AACT,MAAM,OAAO,GAAG,CAAC,MAAM,eAAe,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,EAAC;AAChG,MAAM,CAAC,MAAM;AACb,MAAM,OAAO,GAAG,GAAE;AAClB,MAAM;AACN,KAAK,IAAI,CAAC,iBAAiB,GAAG,EAAE,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,GAAG,GAAG,OAAO,GAAE;AAC9E,KAAK,IAAI,CAAC,iBAAiB,GAAG,EAAE,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,GAAG,GAAG,KAAK,GAAE;AAC5E,KAAK,IAAI,EAAE,CAAC,SAAS,KAAK,IAAI,IAAI,EAAE,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;AACjI,MAAM,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,MAAK;AACtD,MAAM;AACN,KAAK,CAAC,EAAC;AACP,GAAG;AACH;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE;AACjC,GAAG,IAAI,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE;AACvB,IAAI,MAAM;AACV,IAAI;AACJ,GAAG,MAAM,KAAK,GAAG,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,GAAG,MAAM,CAAC,KAAK,IAAI,MAAM,IAAI,IAAI,EAAC;AACvF,GAAG,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,MAAK;AACxC;AACA;AACA;AACA;AACA,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAC;AAC3D,GAAG;AACH,EAAE;AACF;;;;"}