@conduction/nextcloud-vue 2.96.0 → 2.98.0

package/src/composables/indexSources.js

@@ -3,8 +3,8 @@
  * SPDX-FileCopyrightText: 2026 Conduction B.V. <info@conduction.nl>
  */
 
-import { translate as t } from '@nextcloud/l10n'
-import { generateUrl } from '@nextcloud/router'
+import { getCanonicalLocale, translate as t } from '@nextcloud/l10n'
+import { generateOcsUrl, generateUrl } from '@nextcloud/router'
 import { reactive } from 'vue'
 import CalendarClock from 'vue-material-design-icons/CalendarClock.vue'
 import HandBackRight from 'vue-material-design-icons/HandBackRight.vue'
@@ -12,7 +12,10 @@ import LightningBolt from 'vue-material-design-icons/LightningBolt.vue'
 import Pencil from 'vue-material-design-icons/Pencil.vue'
 import { formatRelativeDate } from '../utils/boardDate.js'
 import { FLOW_RUN_ERROR_STATUSES, flowRunStatuses } from '../utils/flowRunStatus.js'
+import { fetchGroupMembers, fetchPresence, fetchStatuses } from '../utils/nextcloudDirectory.js'
+import { readPath } from '../utils/readPath.js'
 import { useFlowStore } from './useFlowStore.js'
+import { organisationRecord, useOrganisationStore } from './useOrganisationStore.js'
 import { useTaskInboxStore } from './useTaskInboxStore.js'
 
 /**
@@ -714,6 +717,386 @@ function endpointSource() {
 	}
 }
 
+/**
+ * Fill `{field}` placeholders in a link template from a row.
+ *
+ * @param {string} template A path such as `/apps/dossiq/cases/{id}`.
+ * @param {object} row The row.
+ * @return {string} The path.
+ */
+function fillRowTemplate(template, row) {
+	return String(template).replace(/\{([\w.@]+)\}/g, (match, path) => {
+		const value = readPath(row, path)
+		return value === undefined || value === null ? '' : encodeURIComponent(String(value))
+	})
+}
+
+/**
+ * The search source: one search term over several OpenRegister schemas and
+ * the reader's files (`entitySource: "search"`), with a quick filter per kind
+ * and its count (DqZoekresultaten).
+ *
+ * `sourceConfig.kinds` lists what is searched:
+ * `{ id, label, register, schema, titleField?, subtitleField?, statusField?, 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
+ * address's `?q=` (or `sourceConfig.termQuery`). A kind that fails shows no
+ * rows and no count; the others still answer.
+ *
+ * @param {object} [config] The page's source config.
+ * @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
+ */
+function searchSource(config = {}) {
+	const kinds = (Array.isArray(config && config.kinds) ? config.kinds : [])
+		.filter((kind) => kind && typeof kind.id === 'string' && kind.id !== '' && (kind.files === true || (kind.register && kind.schema)))
+	const state = reactive({ rows: [], totals: {}, loading: false, kind: 'all', term: '' })
+	let seq = 0
+
+	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 : [])
+		return {
+			total: typeof body.total === 'number' ? body.total : results.length,
+			rows: results.map((object) => {
+				const id = object.id || object.uuid || (object['@self'] && object['@self'].id)
+				return {
+					id: `${kind.id}:${id}`,
+					kind: kind.id,
+					kindLabel: kind.label,
+					title: String(readPath(object, kind.titleField || 'title') ?? object.name ?? id ?? ''),
+					subtitle: kind.subtitleField ? String(readPath(object, kind.subtitleField) ?? '') : '',
+					status: kind.statusField ? String(readPath(object, kind.statusField) ?? '') : '',
+					href: kind.href ? generateUrl(fillRowTemplate(kind.href, { ...object, id })) : '',
+					object,
+				}
+			}),
+		}
+	}
+
+	const searchFiles = async (axios, kind, term) => {
+		const res = await axios.get(generateOcsUrl('search/providers/files/search'), {
+			params: { term, limit: kind.limit || 20, format: 'json' },
+			headers: { 'OCS-APIRequest': 'true' },
+		})
+		const entries = (res && res.data && res.data.ocs && res.data.ocs.data && res.data.ocs.data.entries) || []
+		return {
+			total: entries.length,
+			rows: entries.map((entry, index) => ({
+				id: `${kind.id}:${entry.resourceUrl || index}`,
+				kind: kind.id,
+				kindLabel: kind.label,
+				title: entry.title || '',
+				subtitle: entry.subline || '',
+				status: '',
+				href: entry.resourceUrl || '',
+			})),
+		}
+	}
+
+	return {
+		/**
+		 * Run the search over every kind, in parallel.
+		 *
+		 * @param {object} cfg The page's source config with the active tab's `kind` merged in.
+		 * @return {Promise<void>} Resolves when every kind answered or failed.
+		 */
+		load: async (cfg) => {
+			state.kind = cfg && typeof cfg.kind === 'string' ? cfg.kind : 'all'
+			const query = typeof window !== 'undefined' ? new URLSearchParams(window.location.search) : null
+			const term = String((cfg && cfg.term) || (query && query.get((cfg && cfg.termQuery) || 'q')) || '').trim()
+			const mine = ++seq
+			state.term = term
+			if (term === '' || kinds.length === 0) {
+				state.rows = []
+				state.totals = {}
+				return
+			}
+			state.loading = true
+			const { default: axios } = await import('@nextcloud/axios')
+			const answers = await Promise.all(kinds.map((kind) => (kind.files === true ? searchFiles(axios, kind, term) : searchObjects(axios, kind, term)).catch(() => null)))
+			if (mine !== seq) {
+				return
+			}
+			const totals = {}
+			const rows = []
+			answers.forEach((answer, index) => {
+				if (answer) {
+					totals[kinds[index].id] = answer.total
+					rows.push(...answer.rows)
+				}
+			})
+			state.totals = totals
+			state.rows = rows
+			state.loading = false
+		},
+
+		/**
+		 * @return {Array<object>} The results of the active kind, or all of them.
+		 */
+		rows: () => (state.kind === 'all' ? state.rows : state.rows.filter((row) => row.kind === state.kind)),
+
+		/**
+		 * @return {boolean} Whether a search is in flight.
+		 */
+		loading: () => state.loading,
+
+		columns: [
+			{ key: 'title', label: t('nextcloud-vue', 'Result'), secondary: 'subtitle' },
+			{ key: 'kindLabel', label: t('nextcloud-vue', 'Kind') },
+			{ key: 'status', label: t('nextcloud-vue', 'Status') },
+		],
+
+		quickFilters: kinds.length > 0
+			? [
+					{ label: t('nextcloud-vue', 'All'), filter: { kind: 'all' }, default: true },
+					...kinds.map((kind) => ({ label: kind.label || kind.id, filter: { kind: kind.id } })),
+				]
+			: null,
+
+		/**
+		 * The number on each kind's quick filter: the total each search
+		 * reported, and their sum on All.
+		 *
+		 * @return {Record<number, number>} The counts by tab index.
+		 */
+		tabCounts: () => {
+			const counts = { 0: Object.values(state.totals).reduce((sum, value) => sum + value, 0) }
+			kinds.forEach((kind, index) => {
+				if (typeof state.totals[kind.id] === 'number') {
+					counts[index + 1] = state.totals[kind.id]
+				}
+			})
+			return counts
+		},
+
+		/**
+		 * Open a result where it lives.
+		 *
+		 * @param {object} row The clicked row.
+		 * @return {void}
+		 */
+		openRow: (row) => {
+			if (row && row.href) {
+				window.location.assign(row.href)
+			}
+		},
+
+		/**
+		 * @param {object} row A row.
+		 * @return {string|null} The URL the row opens, for a new tab.
+		 */
+		rowTarget: (row) => (row && row.href) || null,
+	}
+}
+
+/**
+ * The users source: the members of a Nextcloud group, with their function,
+ * roles, e-mail and whether they are in today (`entitySource: "users"`,
+ * DqAfdelingen). Pair it with `folderSidebar: { source: 'groups',
+ * filterField: 'group' }`, which lists the groups as the folder tree; the
+ * selected group arrives as `group`. `sourceConfig.group` is the group shown
+ * before one is picked.
+ *
+ * Today is the dav app's out-of-office period when one runs now ("Absent
+ * until 14 Oct"), else the user status (present, away) and its message. The
+ * function is the profile `headline`, the roles the profile `role`, unless
+ * `sourceConfig.functionField` / `rolesField` name other user fields.
+ * Listing a group needs an admin or the group's sub-admin; a refused request
+ * leaves the list empty.
+ *
+ * @return {object} The source adapter.
+ * @spec openspec/changes/index-groups-users-source/specs/index-page/spec.md#requirement-an-index-page-can-list-nextcloud-groups-and-their-members
+ */
+function usersSource() {
+	const state = reactive({ rows: [], loading: false })
+	let seq = 0
+	const presenceLabels = {
+		present: t('nextcloud-vue', 'Present'),
+		away: t('nextcloud-vue', 'Away'),
+	}
+	const presenceColors = {
+		[presenceLabels.present]: 'success',
+		[presenceLabels.away]: 'info',
+	}
+
+	return {
+		/**
+		 * Load the group's members and their presence.
+		 *
+		 * @param {object} config The page's source config with the picked `group`.
+		 * @return {Promise<void>} Resolves when loaded.
+		 */
+		load: async (config) => {
+			const group = String((config && (config.group || config.defaultGroup)) || '')
+			const mine = ++seq
+			if (group === '') {
+				state.rows = []
+				return
+			}
+			state.loading = true
+			try {
+				const { default: axios } = await import('@nextcloud/axios')
+				const [members, statuses] = await Promise.all([fetchGroupMembers(axios, group), fetchStatuses(axios)])
+				const functionField = (config && config.functionField) || 'headline'
+				const rolesField = (config && config.rolesField) || 'role'
+				const rows = await Promise.all(members.map(async (user) => {
+					const presence = await fetchPresence(axios, user.id, statuses[user.id] || null)
+					let today = ''
+					if (presence.state === 'absent') {
+						const until = presence.until ? new Date(`${presence.until}T12:00:00`) : null
+						today = until
+							? t('nextcloud-vue', 'Absent until {date}', { date: until.toLocaleDateString(getCanonicalLocale() || undefined, { day: 'numeric', month: 'short' }) })
+							: t('nextcloud-vue', 'Absent')
+					} else if (presence.message) {
+						today = presence.message
+					} else if (presenceLabels[presence.state]) {
+						today = presenceLabels[presence.state]
+					}
+					return {
+						id: user.id,
+						displayname: user.displayname || user['display-name'] || user.id,
+						function: String(user[functionField] || ''),
+						roles: String(user[rolesField] || ''),
+						email: user.email || '',
+						today,
+						presence: presence.state,
+					}
+				}))
+				if (mine === seq) {
+					state.rows = rows.sort((a, b) => a.displayname.localeCompare(b.displayname))
+				}
+			} catch (error) {
+				if (mine === seq) {
+					state.rows = []
+				}
+				throw error
+			} finally {
+				if (mine === seq) {
+					state.loading = false
+				}
+			}
+		},
+
+		/**
+		 * @return {Array<object>} The members.
+		 */
+		rows: () => state.rows,
+
+		/**
+		 * @return {boolean} Whether a load is in flight.
+		 */
+		loading: () => state.loading,
+
+		columns: [
+			{ key: 'displayname', label: t('nextcloud-vue', 'Employee'), secondary: 'function' },
+			{ key: 'roles', label: t('nextcloud-vue', 'Roles') },
+			{ key: 'email', label: t('nextcloud-vue', 'E-mail') },
+			{ key: 'today', label: t('nextcloud-vue', 'Today'), widget: 'badge', widgetProps: { colorMap: presenceColors, variant: 'warning' } },
+		],
+
+		searchFields: {
+			group: { param: 'group', single: true },
+		},
+
+		showAdd: false,
+	}
+}
+
+/**
+ * The organisations source: OpenRegister organisations, which are not
+ * register/schema objects.
+ *
+ * The list is the viewer's own organisations and the single read refuses an
+ * organisation the viewer has no access to; both are decided by OpenRegister
+ * from the session. The adapter forwards nothing that could widen that.
+ *
+ * It is a RECORD source as well (`loadRecord` + `record`), so a
+ * `type: "detail"` page with the same `entitySource` shows one organisation
+ * with the header, pills, facts and `@objectId` / `@object.*` tokens an object
+ * page has.
+ *
+ * @return {object} The source adapter.
+ * @spec openspec/changes/organisations-entity-source/specs/organisations-entity-source/spec.md
+ */
+function organisationsSource() {
+	const store = useOrganisationStore()
+
+	const statusLabels = {
+		provisioning: t('nextcloud-vue', 'Provisioning'),
+		active: t('nextcloud-vue', 'Active'),
+		suspended: t('nextcloud-vue', 'Suspended'),
+		deprovisioning: t('nextcloud-vue', 'Deprovisioning'),
+		archived: t('nextcloud-vue', 'Archived'),
+		retained: t('nextcloud-vue', 'Retained'),
+	}
+
+	return {
+		store,
+
+		/**
+		 * Load the viewer's organisations. The endpoint takes no parameters.
+		 *
+		 * @return {Promise<void>} Resolves when loaded.
+		 */
+		load: () => store.load(),
+
+		/**
+		 * @return {Array<object>} The rows, keyed on the organisation uuid.
+		 */
+		rows: () => (store.organisations || []).map(organisationRecord),
+
+		/**
+		 * @return {boolean} Whether a load is in flight.
+		 */
+		loading: () => !!store.loading,
+
+		/**
+		 * Read one organisation for a detail page.
+		 *
+		 * @param {string} id The organisation uuid.
+		 * @return {Promise<object|null>} The organisation, or null when it could not be read.
+		 */
+		loadRecord: (id) => store.fetchRecord(id),
+
+		/**
+		 * @param {string} id The organisation uuid.
+		 * @return {object|null} The organisation read for this id, keyed on its uuid, or null.
+		 */
+		record: (id) => {
+			const organisation = store.records?.[String(id)]
+			return organisation ? organisationRecord(organisation) : null
+		},
+
+		/**
+		 * @param {string} id The organisation uuid.
+		 * @return {number|null} The HTTP status of a failed read of this id, or null.
+		 */
+		recordError: (id) => store.recordErrors?.[String(id)] ?? null,
+
+		columns: [
+			{ key: 'name', label: t('nextcloud-vue', 'Name') },
+			{
+				key: 'status',
+				label: t('nextcloud-vue', 'Status'),
+				enum: Object.keys(statusLabels),
+				enumLabels: statusLabels,
+				colorMap: { active: 'success', provisioning: 'info', suspended: 'warning', deprovisioning: 'error', archived: 'default', retained: 'default' },
+			},
+			{ key: 'type', label: t('nextcloud-vue', 'Type') },
+			{ key: 'created', label: t('nextcloud-vue', 'Created'), type: 'string', format: 'date-time' },
+		],
+
+		// Creating an organisation is not the index's object form, and
+		// OpenRegister has no delete for one, so neither action is offered.
+		showAdd: false,
+		title: t('nextcloud-vue', 'Organisations'),
+	}
+}
+
 /**
  * The registered sources, by the name a manifest uses.
  *
@@ -726,6 +1109,9 @@ export const indexSources = {
 	flowRuns: flowRunsSource,
 	tasks: tasksSource,
 	endpoint: endpointSource,
+	search: searchSource,
+	users: usersSource,
+	organisations: organisationsSource,
 }
 
 /**
@@ -738,10 +1124,11 @@ export const indexSources = {
  * indistinguishable from a source that genuinely has no rows.
  *
  * @param {string} name The source name from `config.source`.
+ * @param {object} [config] The page's source config, for a source that builds its tabs from it.
  *
  * @return {object|null} The adapter, or null when the name is not registered.
  */
-export function resolveIndexSource(name) {
+export function resolveIndexSource(name, config) {
 	const key = String(name || '')
 	if (!key) {
 		return null
@@ -754,5 +1141,33 @@ export function resolveIndexSource(name) {
 		return null
 	}
 
-	return factory()
+	return factory(config || {})
+}
+
+/**
+ * Resolve a named source for ONE record, for a `type: "detail"` page.
+ *
+ * The same registry as the index: a source that can also read a single record
+ * supplies `loadRecord(id)` and `record(id)`, and the detail page names it with
+ * the same `entitySource`. A name that is unknown, or a source that cannot read
+ * one record, resolves to null with a console warning, and the page shows no
+ * record rather than the wrong one.
+ *
+ * @param {string} name The source name from `config.entitySource`.
+ * @return {object|null} The adapter, or null.
+ * @spec openspec/changes/organisations-entity-source/specs/organisations-entity-source/spec.md
+ */
+export function resolveRecordSource(name) {
+	const key = String(name || '')
+	if (!key) {
+		return null
+	}
+	const factory = indexSources[key]
+	const source = typeof factory === 'function' ? factory() : null
+	if (!source || typeof source.loadRecord !== 'function' || typeof source.record !== 'function') {
+		// eslint-disable-next-line no-console
+		console.warn(`[CnDetailPage] entitySource "${key}" is not a source that reads one record. The page shows no record.`)
+		return null
+	}
+	return source
 }

package/src/composables/useOrganisationStore.js

@@ -0,0 +1,111 @@
+/**
+ * SPDX-License-Identifier: EUPL-1.2
+ * SPDX-FileCopyrightText: 2026 Conduction B.V. <info@conduction.nl>
+ */
+
+import axios from '@nextcloud/axios'
+import { generateUrl } from '@nextcloud/router'
+import { defineStore } from 'pinia'
+
+/**
+ * OpenRegister's organisation endpoints, behind the `organisations` entity source.
+ *
+ * An organisation is not a register/schema object, so the object store cannot
+ * read it. Both reads answer from the session: the list holds only the
+ * organisations the viewer belongs to, and one organisation answers 403 when
+ * the viewer has no access to it. This store adds no check of its own and
+ * skips none.
+ *
+ * @type {string}
+ */
+export const ORGANISATIONS_URL = '/apps/openregister/api/organisations'
+
+/**
+ * One organisation as a row or a record: the organisation as OpenRegister
+ * serialises it, with `id` set to its uuid. An OpenRegister object's `id` is
+ * its uuid as well, so `@object.id`, a row route and the page's `objectId`
+ * all name the same thing. The numeric database id stays out of sight.
+ *
+ * @param {object} organisation The organisation from the endpoint.
+ * @return {object} The organisation keyed on its uuid.
+ */
+export function organisationRecord(organisation) {
+	return { ...organisation, id: organisation?.uuid ?? organisation?.id ?? null }
+}
+
+/**
+ * The organisations store.
+ *
+ * @spec openspec/changes/organisations-entity-source/specs/organisations-entity-source/spec.md
+ */
+export const useOrganisationStore = defineStore('cnOrganisations', {
+	state: () => ({
+		/** @type {Array<object>} The viewer's organisations, as the list endpoint returned them. */
+		organisations: [],
+		/** @type {boolean} Whether the list load is in flight. */
+		loading: false,
+		/** @type {string|null} The last list failure, for the console trail. */
+		error: null,
+		/** @type {Record<string, object>} Single organisations read so far, by uuid. */
+		records: {},
+		/** @type {Record<string, number|null>} The HTTP status of a failed single read, by uuid. */
+		recordErrors: {},
+	}),
+
+	actions: {
+		/**
+		 * Load the viewer's organisations. The endpoint takes no parameters and
+		 * returns every organisation the viewer belongs to in one response.
+		 *
+		 * @return {Promise<void>} Resolves when the rows are in the store.
+		 */
+		async load() {
+			this.loading = true
+			this.error = null
+			try {
+				const response = await axios.get(generateUrl(ORGANISATIONS_URL))
+				this.organisations = Array.isArray(response.data?.results) ? response.data.results : []
+			} catch (error) {
+				this.error = error?.message || String(error)
+				this.organisations = []
+				// eslint-disable-next-line no-console
+				console.error('[useOrganisationStore] Loading the organisations failed', error)
+			} finally {
+				this.loading = false
+			}
+		},
+
+		/**
+		 * Read one organisation into `records`. A refusal (403) or a missing
+		 * organisation (404) leaves no record and keeps the status in
+		 * `recordErrors`, so the page can tell "not found" from "still loading".
+		 *
+		 * @param {string} uuid The organisation uuid.
+		 * @return {Promise<object|null>} The organisation, or null when it could not be read.
+		 */
+		async fetchRecord(uuid) {
+			const key = String(uuid || '')
+			if (key === '') {
+				return null
+			}
+			try {
+				const response = await axios.get(generateUrl(`${ORGANISATIONS_URL}/${encodeURIComponent(key)}`))
+				const organisation = response.data?.organisation || null
+				const { [key]: dropped, ...errors } = this.recordErrors
+				this.recordErrors = errors
+				if (!organisation) {
+					return null
+				}
+				this.records = { ...this.records, [key]: organisation }
+				return organisation
+			} catch (error) {
+				const { [key]: dropped, ...records } = this.records
+				this.records = records
+				this.recordErrors = { ...this.recordErrors, [key]: error?.response?.status ?? null }
+				// eslint-disable-next-line no-console
+				console.error(`[useOrganisationStore] Loading organisation "${key}" failed`, error)
+				return null
+			}
+		},
+	},
+})

package/src/index.js

@@ -59,6 +59,7 @@ export {
 	CnChartWidget,
 	CnChartWidgetForm,
 	CnChatPage,
+	CnChecklistRunWidget,
 	CnChildRecordsField,
 	CnChipsFieldWidget,
 	CnChoiceCards,
@@ -236,6 +237,7 @@ export {
 	CnObjectRow,
 	CnObjectSidebar,
 	CnOfflineQueue,
+	CnOrderedListField,
 	CnPageHeader,
 	CnPageRenderer,
 	CnPagination,