@conduction/nextcloud-vue 2.137.0 → 2.139.0

package/dist/esm/composables/indexSources.js

@@ -1,9 +1,11 @@
 import { translate, getCanonicalLocale } from '@nextcloud/l10n';
 import { generateUrl, generateOcsUrl } from '@nextcloud/router';
 import { reactive } from 'vue';
+import AccountOutline from 'vue-material-design-icons/AccountOutline.vue';
 import CalendarClock from 'vue-material-design-icons/CalendarClock.vue';
 import Cancel from 'vue-material-design-icons/Cancel.vue';
 import Check from 'vue-material-design-icons/Check.vue';
+import EmailOutline from 'vue-material-design-icons/EmailOutline.vue';
 import HandBackRight from 'vue-material-design-icons/HandBackRight.vue';
 import LightningBolt from 'vue-material-design-icons/LightningBolt.vue';
 import Pencil from 'vue-material-design-icons/Pencil.vue';
@@ -14,6 +16,7 @@ import { fillTemplate } from '../utils/fillTemplate.js';
 import { flowRunStatuses, FLOW_RUN_ERROR_STATUSES } from '../utils/flowRunStatus.js';
 import { fetchUsers, fetchGroupMembers, fetchStatuses, fetchPresence } from '../utils/nextcloudDirectory.js';
 import { readPath } from '../utils/readPath.js';
+import { resolveNextcloudUser } from '../utils/userAutocomplete.js';
 import { useFlowStore } from './useFlowStore.js';
 import { useOrganisationStore, organisationRecord } from './useOrganisationStore.js';
 import { useTaskInboxStore } from './useTaskInboxStore.js';
@@ -1089,7 +1092,7 @@ function fillRowTemplate(template, row) {
  * and its count (DqZoekresultaten).
  *
  * `sourceConfig.kinds` lists what is searched:
- * `{ id, label, register, schema, titleField?, subtitleField?, statusField?, statusResolve?, linkedField?, linkedTemplate?, href?, limit? }`
+ * `{ id, label, register, schema, titleField?, subtitleField?, subtitleTemplate?, statusField?, statusResolve?, linkedField?, linkedTemplate?, linkedUser?, href?, limit? }`
  * for objects (OpenRegister's `_search`, so the reader sees what they may
  * read), or `{ id, label, files: true, limit? }` for the reader's files
  * (Nextcloud's unified search). The term is `sourceConfig.term`, else the
@@ -1103,6 +1106,10 @@ function fillRowTemplate(template, row) {
  * coloured by `sourceConfig.statusColorMap`. `linkedTemplate` (a field
  * template, "{case.title}") or `linkedField` (a path) fills the "Linked"
  * column, drawn when a kind declares one; `sourceConfig.linkedLabel` names it.
+ * `subtitleTemplate` ("Case {identifier}", translated) fills the line under a
+ * result, else `subtitleField`.
+ * `linkedUser: true` reads that value as a user id and shows the user's
+ * display name. `sourceConfig.columnWidths` sets a width per column key.
  * The page's title and count line can name the term as `{term}`, and the
  * count is the active kind's total. Kind, link and status are filterable.
  *
@@ -1112,6 +1119,23 @@ function fillRowTemplate(template, row) {
  * @return {object} The source adapter.
  * @spec openspec/changes/index-search-source/specs/index-page/spec.md#requirement-an-index-page-can-search-several-schemas-and-files
  */
+/**
+ * Columns with the widths a page names per column key
+ * (`sourceConfig.columnWidths`, `{ title: '250px' }`); a column it does not
+ * name keeps none.
+ *
+ * @param {Array<object>} columns The columns.
+ * @param {object|undefined} widths The widths by key.
+ * @return {Array<object>} The columns.
+ * @spec openspec/changes/search-linked-user-and-widths/specs/search-linked-user-and-widths/spec.md
+ */
+function withColumnWidths(columns, widths) {
+	if (!widths || typeof widths !== 'object') {
+		return columns
+	}
+	return columns.map((col) => (typeof widths[col.key] === 'string' && widths[col.key] !== '' ? { ...col, width: widths[col.key] } : col))
+}
+
 function searchSource(config = {}, context = {}) {
 	const translate$1 = typeof context.translate === 'function' ? context.translate : (text) => text;
 	const kinds = (Array.isArray(config && config.kinds) ? config.kinds : [])
@@ -1200,12 +1224,27 @@ function searchSource(config = {}, context = {}) {
 		return ''
 	};
 
+	const subtitleOf = (kind, object) => {
+		if (kind.subtitleTemplate) {
+			return fillTemplate(translate$1(kind.subtitleTemplate), object)
+		}
+		return kind.subtitleField ? String(readPath(object, kind.subtitleField) ?? '') : ''
+	};
+
+	// `linkedUser`: the Linked cell holds a user id; name the user instead.
+	const linkedUserNames = async (kind, objects) => {
+		const ids = [...new Set(objects.map((object) => linkedOf(kind, object)).filter((id) => id !== ''))];
+		const options = await Promise.all(ids.map((id) => resolveNextcloudUser(id).catch(() => null)));
+		return new Map(ids.map((id, index) => [id, (options[index] && options[index].label) || id]))
+	};
+
 	const searchObjects = async (axios, kind, term) => {
 		const url = generateUrl('/apps/openregister/api/objects/{register}/{schema}', { register: kind.register, schema: kind.schema });
 		const res = await axios.get(url, { params: { _search: term, _limit: kind.limit || 20 } });
 		const body = (res && res.data) || {};
 		const results = Array.isArray(body.results) ? body.results : (Array.isArray(body) ? body : []);
 		const labels = kind.statusResolve && kind.statusField ? await statusLabels(kind) : null;
+		const userNames = kind.linkedUser === true ? await linkedUserNames(kind, results) : null;
 		return {
 			total: typeof body.total === 'number' ? body.total : results.length,
 			rows: results.map((object) => {
@@ -1220,9 +1259,9 @@ function searchSource(config = {}, context = {}) {
 					kindLabel: kind.label,
 					kindText: kindTextOf(kind, object),
 					title: String(readPath(object, kind.titleField || 'title') ?? object.name ?? id ?? ''),
-					subtitle: kind.subtitleField ? String(readPath(object, kind.subtitleField) ?? '') : '',
+					subtitle: subtitleOf(kind, object),
 					status,
-					linked: linkedOf(kind, object),
+					linked: userNames ? (userNames.get(linkedOf(kind, object)) || linkedOf(kind, object)) : linkedOf(kind, object),
 					href: kind.href ? generateUrl(fillRowTemplate(kind.href, { ...object, id })) : '',
 					object,
 				}
@@ -1330,7 +1369,7 @@ function searchSource(config = {}, context = {}) {
 		 */
 		loading: () => state.loading,
 
-		columns: [
+		columns: withColumnWidths([
 			{ key: 'title', label: translate('nextcloud-vue', 'Result'), secondary: 'subtitle', sortable: true },
 			// `kindAsText`: what one row is, as plain text ("Zaak", "Lantaarnpaal",
 			// DqZoekresultaten), instead of the plural kind as a pill.
@@ -1345,7 +1384,7 @@ function searchSource(config = {}, context = {}) {
 				widgetProps: { colorMap: (config && config.statusColorMap) || {} },
 				sortable: true,
 			},
-		],
+		], config && config.columnWidths),
 
 		/**
 		 * Every column header carries a filter button (DqZoekresultaten); the
@@ -1407,14 +1446,24 @@ function searchSource(config = {}, context = {}) {
  * the pager asks for.
  *
  * @param {Array<object>} members The members, by name.
- * @param {object} config `search`, `sortKey`, `sortOrder`, `limit`, `offset`.
+ * @param {object} config `search`, `nameLike`, `rolesLike`, `emailLike`, `today`, `sortKey`, `sortOrder`, `limit`, `offset`.
  * @return {{rows: Array<object>, total: number}} The page and how many match.
  */
 function membersPage(members, config = {}) {
+	const has = (member, fields, text) => fields.some((field) => String(member[field] || '').toLowerCase().includes(text));
 	const term = String(config.search || '').trim().toLowerCase();
-	let rows = term === ''
-		? members.slice()
-		: members.filter((member) => ['displayname', 'function', 'roles', 'email'].some((field) => String(member[field] || '').toLowerCase().includes(term)));
+	let rows = term === '' ? members.slice() : members.filter((member) => has(member, ['displayname', 'function', 'roles', 'email'], term));
+	// The table heads' filters: text contains, and the Today values picked.
+	for (const [param, fields] of [['nameLike', ['displayname', 'function']], ['rolesLike', ['roles']], ['emailLike', ['email']]]) {
+		const text = String(config[param] || '').trim().toLowerCase();
+		if (text !== '') {
+			rows = rows.filter((member) => has(member, fields, text));
+		}
+	}
+	const today = (Array.isArray(config.today) ? config.today : (config.today ? [config.today] : [])).map(String);
+	if (today.length > 0) {
+		rows = rows.filter((member) => today.includes(member.today));
+	}
 	if (config.sortKey) {
 		const sign = config.sortOrder === 'desc' ? -1 : 1;
 		rows = rows.sort((a, b) => sign * String(a[config.sortKey] ?? '').localeCompare(String(b[config.sortKey] ?? '')));
@@ -1476,10 +1525,11 @@ function usersSource() {
 		 */
 		load: async (config) => {
 			const group = String((config && (config.group || config.defaultGroup)) || '');
-			const { search, sortKey, sortOrder, limit, offset, ...request } = config || {};
+			const { search, sortKey, sortOrder, limit, offset, nameLike, rolesLike, emailLike, today, ...request } = config || {};
 			const key = JSON.stringify({ ...request, group });
-			// A new page, term or order of the members already read: no request.
-			if (key === membersKey && (offset !== undefined || search !== undefined || sortKey !== undefined)) {
+			const narrows = [offset, search, sortKey, nameLike, rolesLike, emailLike, today].some((value) => value !== undefined);
+			// A new page, term, order or head filter of the members already read: no request.
+			if (key === membersKey && narrows) {
 				const page = membersPage(readMembers, config);
 				state.rows = page.rows;
 				state.total = page.total;
@@ -1575,8 +1625,24 @@ function usersSource() {
 
 		searchFields: {
 			group: { param: 'group', single: true },
+			'displayname[like]': { param: 'nameLike', single: true },
+			'roles[like]': { param: 'rolesLike', single: true },
+			'email[like]': { param: 'emailLike', single: true },
+			today: { param: 'today' },
 		},
 
+		/** A filter button on every head (DqAfdelingen); the members read are narrowed here. */
+		headerFilters: true,
+
+		/**
+		 * A member's row menu (DqAfdelingen): their Nextcloud profile, and an
+		 * e-mail when they have an address. Both are links.
+		 */
+		rowActions: [
+			{ id: 'open-profile', label: translate('nextcloud-vue', 'Open profile'), icon: AccountOutline, href: (row) => generateUrl(`/u/${encodeURIComponent(row.id)}`) },
+			{ id: 'send-email', label: translate('nextcloud-vue', 'Send email'), icon: EmailOutline, href: (row) => `mailto:${row.email}`, visible: (row) => Boolean(row && row.email) },
+		],
+
 		showAdd: false,
 	}
 }