@conduction/nextcloud-vue 2.83.0 → 2.85.0

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

@@ -46,6 +46,12 @@ var script = {
 		 * draws the screens' board anatomy (screens-kanban-parity).
 		 */
 		cnLook: { default: 'nextcloud' },
+		/**
+		 * The app's cell-formatter registry, provided by CnAppRoot. A card
+		 * role named in `cardRoles.formatters` shows its value through it, as
+		 * the table's cells do (screens-board-reference-columns).
+		 */
+		cnFormatters: { default: () => ({}) },
 	},
 
 	props: {
@@ -186,9 +192,72 @@ var script = {
 			type: Number,
 			default: 0,
 		},
+
+		/**
+		 * The column a row belongs in, for a status whose raw value is not
+		 * the column key: a reference whose rows are merged by name
+		 * (screens-board-reference-columns). Absent, the row's `statusField`
+		 * value is the key.
+		 *
+		 * @type {((row: object) => string)|null}
+		 * @spec openspec/changes/screens-board-reference-columns/specs/board-view/spec.md#requirement-columns-can-be-the-rows-a-field-references
+		 */
+		columnKeyOf: {
+			type: Function,
+			default: null,
+		},
+
+		/**
+		 * Wrap the columns onto more rows, as many to a row as fit at 240px,
+		 * instead of one row that scrolls sideways (manifest
+		 * `config.board.wrap`). For a board with more stages than fit.
+		 *
+		 * @spec openspec/changes/screens-board-reference-columns/specs/board-view/spec.md#requirement-a-wide-board-can-wrap-its-columns
+		 */
+		wrapColumns: {
+			type: Boolean,
+			default: false,
+		},
+
+		/**
+		 * Offer a checkbox on every card, so cards can be selected for the
+		 * list's bulk actions (the same selection the table holds).
+		 *
+		 * @spec openspec/changes/screens-board-reference-columns/specs/board-view/spec.md#requirement-cards-can-be-selected-for-bulk-actions
+		 */
+		selectable: {
+			type: Boolean,
+			default: false,
+		},
+
+		/**
+		 * The selected cards, by row key.
+		 *
+		 * @type {Array<string|number>}
+		 */
+		selectedIds: {
+			type: Array,
+			default: () => [],
+		},
+
+		/**
+		 * The columns one card may move to, asked when its menu opens or its
+		 * drag starts: `(card) => Promise<Array<string>|null>`, column keys,
+		 * `null` for every column. A column the card cannot reach is greyed
+		 * during the drag and marked "not allowed" in the menu, and a drop on
+		 * it is refused without asking the host. Absent, every column is
+		 * offered and the host's move decides.
+		 *
+		 * @type {((card: object) => Promise<Array<string>|null>)|null}
+		 * @spec openspec/changes/screens-board-reference-columns/specs/board-view/spec.md#requirement-the-board-shows-where-a-card-can-go
+		 */
+		allowedMoves: {
+			type: Function,
+			default: null,
+		},
 	},
 
-	emits: ['card-click', 'card-aux-click', 'moved', 'refused', 'stale', 'load-more'],
+	emits: ['card-click', 'card-aux-click', 'moved', 'refused', 'stale', 'load-more', 'select'],
 
 	data() {
 		return {
@@ -204,6 +273,10 @@ var script = {
 			expanded: [],
 			/** The card whose menu is open (board look), by card key. */
 			openMenuKey: null,
+			/** Column keys each card may move to (`allowedMoves`), by card key; absent = not asked yet. */
+			allowedByCard: {},
+			/** The column keys the dragged card may reach, or null for all. */
+			dragAllowed: null,
 		}
 	},
 
@@ -221,6 +294,7 @@ var script = {
 				statusField: this.statusField,
 				offBoardLabel: translate('nextcloud-vue', 'Elsewhere'),
 				colorField: this.colorField,
+				keyOf: this.columnKeyOf,
 			})
 		},
 
@@ -248,9 +322,20 @@ var script = {
 				due: (given && given.due) || '',
 				owner: (given && given.owner) || '',
 				pillColors: (given && given.pillColors) || {},
+				formatters: (given && given.formatters && typeof given.formatters === 'object') ? given.formatters : {},
 			}
 		},
 
+		/** @return {string} The note on a menu target the card cannot reach. */
+		notAllowedLabel() {
+			return translate('nextcloud-vue', 'not allowed')
+		},
+
+		/** @return {Array<string>} The selected row keys as strings. */
+		selectedKeys() {
+			return (Array.isArray(this.selectedIds) ? this.selectedIds : []).map(String)
+		},
+
 		/** @return {string} The Open in new tab menu item. */
 		openInNewTabLabel() {
 			return translate('nextcloud-vue', 'Open in new tab')
@@ -309,6 +394,97 @@ var script = {
 
 		preventMiddleClickAutoscroll,
 
+		/**
+		 * Whether a card is selected.
+		 *
+		 * @param {object} card The card.
+		 * @return {boolean} True when selected.
+		 */
+		isSelected(card) {
+			return this.selectedKeys.includes(this.cardKey(card))
+		},
+
+		/**
+		 * The checkbox's accessible name.
+		 *
+		 * @param {object} card The card.
+		 * @return {string} "Select <name>".
+		 */
+		selectLabel(card) {
+			const name = this.roleText(card, this.roles.title) || this.cardKey(card);
+			return translate('nextcloud-vue', 'Select {name}', { name })
+		},
+
+		/**
+		 * Select a card, or unselect it.
+		 *
+		 * @param {object} card The card.
+		 * @return {void}
+		 * @spec openspec/changes/screens-board-reference-columns/specs/board-view/spec.md#requirement-cards-can-be-selected-for-bulk-actions
+		 */
+		toggleSelected(card) {
+			const key = this.cardKey(card);
+			const next = this.isSelected(card)
+				? this.selectedIds.filter((id) => String(id) !== key)
+				: [...this.selectedIds, card?.[this.rowKey]];
+			/**
+			 * @event select Emitted when a card's checkbox changes. Payload: the selected row keys.
+			 */
+			this.$emit('select', next);
+		},
+
+		/**
+		 * Ask the host where one card may go (`allowedMoves`), once per card.
+		 *
+		 * @param {object} card The card.
+		 * @return {Promise<Array<string>|null>} The column keys, or null for all.
+		 * @spec openspec/changes/screens-board-reference-columns/specs/board-view/spec.md#requirement-the-board-shows-where-a-card-can-go
+		 */
+		async loadAllowed(card) {
+			if (typeof this.allowedMoves !== 'function') {
+				return null
+			}
+			const key = this.cardKey(card);
+			if (Object.hasOwn(this.allowedByCard, key)) {
+				return this.allowedByCard[key]
+			}
+			let allowed;
+			try {
+				const answer = await this.allowedMoves(card);
+				allowed = Array.isArray(answer) ? answer.map(String) : null;
+			} catch {
+				// Unknown is not "nowhere": the host's move stays the authority.
+				allowed = null;
+			}
+			this.allowedByCard = { ...this.allowedByCard, [key]: allowed };
+			return allowed
+		},
+
+		/**
+		 * Whether a card may move to a column, as far as the board knows.
+		 *
+		 * @param {object} card The card.
+		 * @param {object} target The column.
+		 * @return {boolean} False only when the host said it cannot.
+		 */
+		isMoveAllowed(card, target) {
+			const allowed = this.allowedByCard[this.cardKey(card)];
+			return !Array.isArray(allowed) || allowed.includes(String(target.key))
+		},
+
+		/**
+		 * Whether a column is out of reach for the card being dragged.
+		 *
+		 * @param {object} column The column.
+		 * @return {boolean} True while a drag is on and the card cannot go there.
+		 */
+		isUnreachable(column) {
+			return this.dragging !== null
+				&& Array.isArray(this.dragAllowed)
+				&& column.key !== this.dragging.fromKey
+				&& !this.dragAllowed.includes(String(column.key))
+		},
+
 		/**
 		 * A card's due state under `dueRule`.
 		 *
@@ -350,11 +526,35 @@ var script = {
 			const fields = Array.isArray(role) ? role : [role];
 			return fields
 				.filter((field) => typeof field === 'string' && field !== '')
-				.map((field) => this.textOf(readPath(card, field)))
+				.map((field) => this.fieldText(card, field))
 				.filter((value) => value !== '')
 				.join(' \u00b7 ')
 		},
 
+		/**
+		 * One card field as text: through the formatter `cardRoles.formatters`
+		 * names for it, else the value itself.
+		 *
+		 * @param {object} card The card's row.
+		 * @param {string} field The dot-path.
+		 * @return {string} The text.
+		 * @spec openspec/changes/screens-board-reference-columns/specs/board-view/spec.md#requirement-a-card-field-can-show-through-a-formatter
+		 */
+		fieldText(card, field) {
+			const raw = readPath(card, field);
+			const id = this.roles.formatters[field];
+			const fn = id && this.cnFormatters ? this.cnFormatters[id] : null;
+			if (typeof fn === 'function') {
+				try {
+					const out = fn(raw, card, null);
+					return out === null || out === undefined ? '' : String(out).trim()
+				} catch {
+					return this.textOf(raw)
+				}
+			}
+			return this.textOf(raw)
+		},
+
 		/**
 		 * A value as text: a string or number as is, an object by its label.
 		 *
@@ -379,7 +579,7 @@ var script = {
 		 * @return {string} A CnStatusBadge variant.
 		 */
 		pillVariant(card) {
-			const raw = this.textOf(readPath(card, this.roles.pill));
+			const raw = this.fieldText(card, this.roles.pill);
 			const variant = this.roles.pillColors[raw] ?? this.roles.pillColors[raw.toLowerCase()];
 			return isBadgeVariant(variant) ? variant : 'default'
 		},
@@ -419,7 +619,7 @@ var script = {
 		 * @return {string} The name, '' when there is none.
 		 */
 		ownerName(card) {
-			return this.roles.owner === '' ? '' : this.textOf(readPath(card, this.roles.owner))
+			return this.roles.owner === '' ? '' : this.fieldText(card, this.roles.owner)
 		},
 
 		/**
@@ -571,6 +771,7 @@ var script = {
 			const key = this.cardKey(card);
 			this.openMenuKey = this.openMenuKey === key ? null : key;
 			if (this.openMenuKey !== null) {
+				this.loadAllowed(card);
 				this.focusMenuItem(card, 0);
 			}
 		},
@@ -659,6 +860,7 @@ var script = {
 				event.preventDefault();
 				if (!this.isMenuOpen(card)) {
 					this.openMenuKey = this.cardKey(card);
+					this.loadAllowed(card);
 					this.focusMenuItem(card, 0);
 				}
 			}
@@ -805,8 +1007,27 @@ var script = {
 		 */
 		onDragStart(card, column, event) {
 			this.dragging = { card, fromKey: column.key };
+			this.dragAllowed = null;
 			// Firefox drops a drag that carries no data.
 			event?.dataTransfer?.setData?.('text/plain', this.cardKey(card));
+			if (typeof this.allowedMoves === 'function') {
+				this.loadAllowed(card).then((allowed) => {
+					if (this.dragging && this.dragging.card === card) {
+						this.dragAllowed = allowed;
+					}
+				});
+			}
+		},
+
+		/**
+		 * The drag ended (dropped anywhere, or cancelled): no column stays
+		 * greyed. A drop on a column has already run by now.
+		 *
+		 * @return {void}
+		 */
+		onDragEnd() {
+			this.dragging = null;
+			this.dragAllowed = null;
 		},
 
 		/**
@@ -821,6 +1042,13 @@ var script = {
 			}
 			const { card, fromKey } = this.dragging;
 			this.dragging = null;
+			this.dragAllowed = null;
+			if (column.key !== fromKey && !this.isMoveAllowed(card, column)) {
+				const name = this.roleText(card, this.roles.title) || this.cardKey(card);
+				this.refusal = translate('nextcloud-vue', '{name} cannot move to {column}.', { name, column: column.label });
+				this.$emit('refused', { card, message: this.refusal });
+				return
+			}
 			await this.move(card, fromKey, column.key);
 		},