@conduction/nextcloud-vue 2.96.0 → 2.97.0

package/src/composables/indexSources.js

@@ -4,7 +4,7 @@
  */
 
 import { translate as t } from '@nextcloud/l10n'
-import { generateUrl } from '@nextcloud/router'
+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,6 +12,7 @@ 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 { readPath } from '../utils/readPath.js'
 import { useFlowStore } from './useFlowStore.js'
 import { useTaskInboxStore } from './useTaskInboxStore.js'
 
@@ -714,6 +715,182 @@ 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 registered sources, by the name a manifest uses.
  *
@@ -726,6 +903,7 @@ export const indexSources = {
 	flowRuns: flowRunsSource,
 	tasks: tasksSource,
 	endpoint: endpointSource,
+	search: searchSource,
 }
 
 /**
@@ -738,10 +916,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 +933,5 @@ export function resolveIndexSource(name) {
 		return null
 	}
 
-	return factory()
+	return factory(config || {})
 }

package/src/schemas/app-manifest-v2.schema.json

@@ -3,7 +3,7 @@
 	"$id": "https://raw.githubusercontent.com/ConductionNL/nextcloud-vue/main/src/schemas/app-manifest-v2.schema.json",
 	"title": "Conduction App Manifest v2",
 	"description": "v2 schema for the JSON-driven page and navigation manifest consumed by @conduction/nextcloud-vue. Introduces a uniform widgets[] array on every page type with a per-slot grid coordinate system, a typed actions[] discriminator, and the required $schema field for version detection. v1 manifests continue to validate against app-manifest.schema.json (unchanged).",
-	"version": "2.120.0",
+	"version": "2.121.0",
 	"type": "object",
 	"required": ["$schema", "version"],
 	"allOf": [
@@ -597,7 +597,7 @@
 		"folderSidebarScope": {
 			"type": "object",
 			"additionalProperties": true,
-			"description": "One folder in `config.folderSidebar.folders[]`, which doubles as a SCOPE: the three optional list-layout keys below let one index page show each folder the way that folder needs. Every other key (id, name, icon, ...) stays free-form, so an existing folder list validates unchanged. The page's `config.columns` still decides which columns this page HAS; a scope only decides which of them are shown, in what order, sorted by what and searched over what. A scope naming a column the page does not declare is refused by validateManifestV2, not silently rendered.",
+			"description": "One folder in `config.folderSidebar.folders[]`, which doubles as a SCOPE: the three optional list-layout keys below let one index page show each folder the way that folder needs. Every other key (id, name, icon, ...) stays free-form, so an existing folder list validates unchanged. A scope (or the `x-index` block of the row a register-derived folder comes from) may also carry the presentation keys a query preset sets, under the same names: title, quickFilters, cardFields, countText, searchPlaceholder, footerNote, viewSwitch, addLabel, headerButtons, breadcrumb, headerMeta and afterList (index-scope-presentation); a scope's value wins over a preset's. The page's `config.columns` still decides which columns this page HAS; a scope only decides which of them are shown, in what order, sorted by what and searched over what. A scope naming a column the page does not declare is refused by validateManifestV2, not silently rendered.",
 			"properties": {
 				"columns": {
 					"type": "array",
@@ -3702,9 +3702,10 @@
 						},
 						"entitySource": {
 							"type": "string",
-							"enum": ["flows", "tasks"],
+							"enum": ["flows", "flowRuns", "tasks", "endpoint", "search", "users"],
 							"description": "Name a registered NON-OBJECT entity collection for a type='index' page, instead of register+schema. Deliberately NOT called `source`: that key is already taken on page config and is polymorphic (a URL string in some manifests, an object with `params` in others), so reusing it would give one key two meanings and break six deployed shillinq pages. A flow definition is deliberately not an OpenRegister object, so an index had nothing to bind to and such lists became bespoke type='custom' pages. With a source the index loads the list itself. Takes precedence over register/schema; non-empty `objects` still wins over both. Registered sources live in src/composables/indexSources.js. `tasks` lists the viewer's task inbox from OpenRegister's flow-tasks read (cn-tasks-entity-source)."
 						},
+						"sourceConfig": { "type": "object", "additionalProperties": true, "description": "type='index' with `entitySource`: what the named source loads with. `endpoint`: `url` (an app path, required) and `rowsPath` (default `results`); its other keys go along as query parameters. `search`: `kinds` (`{ id, label, register, schema, titleField?, subtitleField?, statusField?, href?, limit? }` or `{ id, label, files: true }`), `term` and `termQuery` (default `q`). `users`: `defaultGroup`, `functionField`, `rolesField`. `flows` / `tasks`: `app`, `scope`. Maps to CnIndexPage `sourceConfig`.", "properties": { "url": { "type": "string", "minLength": 1 }, "rowsPath": { "type": "string", "minLength": 1 }, "kinds": { "type": "array", "items": { "type": "object", "required": ["id"], "additionalProperties": true, "properties": { "id": { "type": "string", "minLength": 1 }, "label": { "type": "string" }, "register": { "type": "string" }, "schema": { "type": "string" }, "files": { "type": "boolean" } } } }, "term": { "type": "string" }, "termQuery": { "type": "string", "minLength": 1 }, "defaultGroup": { "type": "string", "minLength": 1 } } },
 						"app": {
 							"type": "string",
 							"description": "Scopes a named `entitySource` to one app (e.g. entitySource='flows' with app='dossiq' lists that app's flows)."
@@ -4427,7 +4428,12 @@
 									"searchPlaceholder": { "type": "string", "minLength": 1, "description": "The search placeholder while the preset applies." },
 									"footerNote": { "type": "string", "minLength": 1, "description": "The footer note while the preset applies." },
 									"defaultSort": { "type": "array", "description": "The default sort while the preset applies; same shape as config.defaultSort." },
-									"viewSwitch": { "type": "array", "items": { "type": "string", "enum": ["table", "cards", "board", "map"] }, "description": "The drawn view segments while the preset applies." }
+									"viewSwitch": { "type": "array", "items": { "type": "string", "enum": ["table", "cards", "board", "map"] }, "description": "The drawn view segments while the preset applies." },
+									"addLabel": { "type": "string", "minLength": 1, "description": "The add button label while the preset applies (index-scope-presentation)." },
+									"headerButtons": { "type": "array", "description": "The header buttons while the preset applies; same shape as config.headerButtons (index-scope-presentation)." },
+									"breadcrumb": { "description": "The breadcrumb while the preset applies; same shape as config.breadcrumb (index-scope-presentation).", "anyOf": [{ "$ref": "#/$defs/breadcrumbCrumb" }, { "type": "array", "minItems": 1, "items": { "$ref": "#/$defs/breadcrumbCrumb" } }] },
+									"headerMeta": { "type": "string", "minLength": 1, "description": "The note after the breadcrumb while the preset applies (index-scope-presentation)." },
+									"afterList": { "type": "array", "description": "The cards after the list while the preset applies; same shape as config.afterList (index-scope-presentation).", "items": { "type": "object", "required": ["id", "type"], "properties": { "id": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "subtitle": { "type": "string" }, "content": { "type": "object" }, "headerLink": { "type": "object" } } } }
 								}
 							}
 						},
@@ -4478,6 +4484,7 @@
 							"description": "type='index': the property keys the cards view shows as the facts list of each card, in order; defaults to the first four list columns under the board look (screens-card-parity). Maps to CnIndexPage `cardFields`.",
 							"items": { "type": "string", "minLength": 1 }
 						},
+						"afterList": { "type": "array", "description": "type='index': cards after the list, stacked full width in the listed order, the counterpart of statRow above it (index-scope-presentation). Each entry is a widget definition resolved like statRow's. A query preset or a folder scope can set its own. Maps to CnIndexPage `afterList`.", "items": { "type": "object", "required": ["id", "type"], "properties": { "id": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "subtitle": { "type": "string" }, "content": { "type": "object" }, "headerLink": { "type": "object" } } } },
 						"statRow": {
 							"type": "array",
 							"default": [],

package/src/utils/queryPresets.js

@@ -30,6 +30,11 @@ export const QUERY_PRESET_KEYS = Object.freeze([
 	'footerNote',
 	'defaultSort',
 	'viewSwitch',
+	'addLabel',
+	'headerButtons',
+	'breadcrumb',
+	'headerMeta',
+	'afterList',
 ])
 
 /**
@@ -71,8 +76,9 @@ export function matchQueryPreset(presets, query) {
 }
 
 /**
- * The page config with the preset's allowed keys laid over it, and without
- * `queryPresets` itself (the page component has no such prop).
+ * The page config with the preset's allowed keys laid over it, its `match`
+ * as `fixedFilters`, and without `queryPresets` itself (the page component
+ * has no such prop).
  *
  * @param {object} config The page config.
  * @param {object|null} preset The matched preset, or null.
@@ -89,5 +95,10 @@ export function applyQueryPreset(config, preset) {
 			out[key] = preset[key]
 		}
 	}
+	// The query pairs that chose the preset scope the list: the page shows
+	// them as no removable filter chip.
+	if (preset.match && typeof preset.match === 'object') {
+		out.fixedFilters = { ...preset.match }
+	}
 	return out
 }

package/src/utils/scopeListLayout.js

@@ -3,6 +3,8 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
+import { QUERY_PRESET_KEYS } from './queryPresets.js'
+
 /**
  * The three list-layout keys a `folderSidebar` scope may carry.
  *
@@ -10,6 +12,15 @@
  */
 const SCOPE_LAYOUT_KEYS = ['columns', 'defaultSort', 'searchFields']
 
+/**
+ * The presentation keys a scope may carry beside its list layout: the keys a
+ * query preset may set (`QUERY_PRESET_KEYS`), less the two the list layout
+ * resolves itself (`columns`, `defaultSort`).
+ *
+ * @type {ReadonlyArray<string>}
+ */
+const SCOPE_PRESENTATION_KEYS = Object.freeze(QUERY_PRESET_KEYS.filter((key) => key !== 'columns' && key !== 'defaultSort'))
+
 /**
  * The key of a column entry, in either of the two shapes the manifest accepts:
  * a bare string (legacy shorthand) or a `{ key, label, ... }` object.
@@ -149,4 +160,29 @@ export function resolveScopeLayout({ scope = null, row = null, pageColumns = []
 	return { columns, sortKeys, searchFields }
 }
 
-export { SCOPE_LAYOUT_KEYS }
+/**
+ * The presentation a scope asks for: each of `SCOPE_PRESENTATION_KEYS` the
+ * folder entry declares, else the one its schema row's `x-index` declares.
+ * Only declared keys are in the result, so the page's own value stands for
+ * every other key. These are the keys a query preset sets, under the same
+ * names, and a scope's value wins over a preset's because it is applied on
+ * top of the page config the preset produced.
+ *
+ * @param {object} options Resolution inputs.
+ * @param {(object|null)} [options.scope] The folder entry for the active scope.
+ * @param {(object|null)} [options.row] The schema row the folder derives from.
+ * @return {object} The declared presentation keys.
+ * @spec openspec/changes/index-scope-presentation/specs/index-page/spec.md#requirement-a-preset-or-a-scope-sets-the-list-s-presentation
+ */
+export function resolveScopePresentation({ scope = null, row = null } = {}) {
+	const out = {}
+	for (const key of SCOPE_PRESENTATION_KEYS) {
+		const value = declaredOrRow(scope, row, key)
+		if (value !== undefined) {
+			out[key] = value
+		}
+	}
+	return out
+}
+
+export { SCOPE_LAYOUT_KEYS, SCOPE_PRESENTATION_KEYS }