feat: sort favorite contact first in list

Signed-off-by: greta <gretadoci@gmail.com>

Author: GretaD

src/components/ContactsList/ContactsListItem.vue

@@ -36,6 +36,19 @@
 						v-if="(source.isMultiSelected || hoveringAvatar) && !isStatic"
 						:size="28"
 						:class="{ 'contacts-list__item-avatar-selected': source.isMultiSelected, 'contacts-list__item-avatar-hovered': !source.isMultiSelected }" />
+					<div
+						class="favorite-star"
+						:class="{ favorite: isFavorite }"
+						@click.stop="toggleFavorite">
+						<StarIcon
+							v-if="isFavorite"
+							:size="16"
+							class="favorite-icon" />
+						<StarOutlineIcon
+							v-else
+							:size="16"
+							class="favorite-icon" />
+					</div>
 				</div>
 			</template>
 			<template #subname>
@@ -50,16 +63,36 @@
 					</span>
 				</div>
 			</template>
+			<template #actions>
+				<NcActionButton
+					v-if="!isStatic"
+					@click="toggleFavorite">
+					<template #icon>
+						<StarIcon
+							v-if="isFavorite"
+							:size="20"
+							class="favorite-icon" />
+						<StarOutlineIcon
+							v-else
+							:size="20" />
+					</template>
+					{{ isFavorite ? t('contacts', 'Remove from favorites') : t('contacts', 'Add to favorites') }}
+				</NcActionButton>
+			</template>
 		</ListItem>
 	</div>
 </template>
 
 <script>
+import { showError } from '@nextcloud/dialogs'
 import {
 	NcListItem as ListItem,
+	NcActionButton,
 	NcAvatar,
 } from '@nextcloud/vue'
 import CheckIcon from 'vue-material-design-icons/Check.vue'
+import StarIcon from 'vue-material-design-icons/Star.vue'
+import StarOutlineIcon from 'vue-material-design-icons/StarOutline.vue'
 import RouterMixin from '../../mixins/RouterMixin.js'
 
 export default {
@@ -69,6 +102,9 @@ export default {
 		ListItem,
 		NcAvatar,
 		CheckIcon,
+		NcActionButton,
+		StarIcon,
+		StarOutlineIcon,
 	},
 
 	mixins: [
@@ -117,6 +153,10 @@ export default {
 	},
 
 	computed: {
+		isFavorite() {
+			return this.source.favorite
+		},
+
 		// contact is not draggable when it has not been saved on server as it can't be added to groups/circles before
 		isDraggable() {
 			return !!this.source.dav && this.source.addressbook.id !== 'z-server-generated--system' && !this.isStatic
@@ -151,6 +191,26 @@ export default {
 	},
 
 	methods: {
+		async toggleFavorite() {
+			const contact = this.$store.getters.getContact(this.source.key)
+			if (!contact) {
+				this.logger.error('Could not find contact in store', this.source.key)
+				showError(t('contacts', 'Could not update favorite status'))
+				return
+			}
+			if (!contact.dav) {
+				this.logger.error('Missing DAV object for contact', { contactKey: contact.key })
+				showError(t('contacts', 'Could not update favorite status'))
+				return
+			}
+			try {
+				await this.$store.dispatch('toggleFavorite', contact)
+			} catch (error) {
+				logger.error('Could not toggle favorite state', error)
+				showError(t('contacts', 'Could not update favorite status'))
+			}
+		},
+
 		startDrag(evt, item) {
 			evt.dataTransfer.dropEffect = 'move'
 			evt.dataTransfer.effectAllowed = 'move'
@@ -286,6 +346,7 @@ export default {
 
 .contacts-list__item-icon {
 	cursor: pointer !important;
+	position: relative;
 }
 
 .contacts-list__item-avatar {
@@ -309,4 +370,25 @@ export default {
 		background-color: var(--color-primary-light-hover);
 	}
 }
+
+.favorite-star {
+	position: absolute;
+	top: calc(var(--default-grid-baseline) * -1);
+	inset-inline-end: calc(var(--default-grid-baseline) * -1);
+	opacity: 0;
+	cursor: pointer;
+}
+
+.contacts-list__item-icon:hover .favorite-star {
+	opacity: 1;
+}
+
+.favorite-star.favorite {
+	opacity: 1;
+	color: var(--color-favorite)
+}
+
+.favorite-icon {
+	color: var(--color-favorite);
+}
 </style>

src/models/contact.js

@@ -84,6 +84,19 @@ export default class Contact {
 		this._vCard = shallowRef(value)
 	}
 
+	get favorite() {
+		if (this.dav) {
+			return this.dav.favorite || false
+		}
+		return false
+	}
+
+	set favorite(value) {
+		if (this.dav) {
+			this.dav.favorite = value
+		}
+	}
+
 	/**
 	 * Update internal data of this contact
 	 *

src/store/contacts.js

@@ -42,6 +42,24 @@ function sortData(a, b) {
 		: a.key.localeCompare(b.key)
 }
 
+function sortByFavoriteAndName(a, b) {
+	// favorites always on top
+	if (a.favorite !== b.favorite) {
+		return a.favorite ? -1 : 1
+	}
+	// alphabetical within each group
+	if (!a.value && !b.value) {
+		return 0
+	}
+	if (!a.value) {
+		return 1
+	}
+	if (!b.value) {
+		return -1
+	}
+	return a.value.localeCompare(b.value)
+}
+
 const state = {
 	// Using objects for performance
 	// https://codepen.io/skjnldsv/pen/ZmKvQo
@@ -51,7 +69,6 @@ const state = {
 }
 
 const mutations = {
-
 	/**
 	 * Store raw contacts into state
 	 * Used by the first contact fetch
@@ -70,6 +87,36 @@ const mutations = {
 		}, state.contacts)
 	},
 
+	/**
+	 * Store favorite state into store
+	 *
+	 * @param {object} state Default state
+	 * @param {Contact} contact Contact
+	 */
+	updateContactFavorite(state, contact) {
+		if (!state.contacts[contact.key] || !(contact instanceof Contact)) {
+			console.error('Invalid contact update', contact)
+			return
+		}
+
+		if (state.contacts[contact.key].dav) {
+			state.contacts[contact.key].dav.favorite = contact.dav.favorite
+		}
+
+		const sortedContact = state.sortedContacts.find((c) => c.key === contact.key)
+		if (sortedContact) {
+			sortedContact.favorite = contact.favorite || false
+		}
+
+		state.sortedContacts = Object.values(state.contacts)
+			.filter((c) => c.kind !== 'group')
+			.map((c) => ({
+				key: c.key,
+				value: (c[state.orderKey] || '').toString().toLowerCase(),
+				favorite: c.favorite || false,
+			}))
+			.sort(sortByFavoriteAndName)
+	},
 	/**
 	 * Delete a contact from the global contacts list
 	 *
@@ -93,33 +140,42 @@ const mutations = {
 	 * @param {Contact} contact the contact to add
 	 */
 	addContact(state, contact) {
+		// Checking contact validity 🔍🙈
 		if (contact instanceof Contact) {
-			// Checking contact validity 🔍🙈
 			validate(contact)
 
 			const sortedContact = {
 				key: contact.key,
-				value: contact[state.orderKey],
+				value: (contact[state.orderKey] || '').toString().toLowerCase(),
+				favorite: contact.favorite,
 			}
 
 			// Not using sort, splice has far better performances
 			// https://jsperf.com/sort-vs-splice-in-array
 			for (let i = 0, len = state.sortedContacts.length; i < len; i++) {
-				if (sortData(state.sortedContacts[i], sortedContact) >= 0) {
-					state.sortedContacts.splice(i, 0, sortedContact)
-					break
-				} else if (i + 1 === len) {
-					// we reached the end insert it now
+				const other = state.sortedContacts[i]
+
+				// favorite comes before non-favorite
+				const differentFavStatus = other.favorite !== sortedContact.favorite
+				const otherShouldComeFirst = differentFavStatus && other.favorite
+				const sameFavAndSortedFirst = !differentFavStatus && sortData(other, sortedContact) >= 0
+
+				if (otherShouldComeFirst || sameFavAndSortedFirst) {
+					continue
+				}
+
+				if (i + 1 === len) {
 					state.sortedContacts.push(sortedContact)
+				} else {
+					state.sortedContacts.splice(i, 0, sortedContact)
 				}
+				break
 			}
 
-			// sortedContact is empty, just push it
 			if (state.sortedContacts.length === 0) {
 				state.sortedContacts.push(sortedContact)
 			}
 
-			// default contacts list
 			state.contacts[contact.key] = contact
 		} else {
 			console.error('Error while adding the following contact', contact)
@@ -134,17 +190,29 @@ const mutations = {
 	 */
 	updateContact(state, contact) {
 		if (state.contacts[contact.key] && contact instanceof Contact) {
-			// replace contact object data
+			const existingFavorite = state.contacts[contact.key].dav?.favorite || false
 			state.contacts[contact.key].updateContact(contact.jCal)
+
+			// restore favorite on dav if it was lost during the update
+			if (state.contacts[contact.key].dav && state.contacts[contact.key].dav.favorite === undefined) {
+				state.contacts[contact.key].dav.favorite = existingFavorite
+			}
+
 			const sortedContact = state.sortedContacts.find((search) => search.key === contact.key)
 
-			// has the sort key changed for this contact ?
-			const hasChanged = sortedContact.value !== contact[state.orderKey]
-			if (hasChanged) {
-				// then update the new data
+			if (!sortedContact) {
+				console.warn('sortedContact not found for', contact.key)
+				return
+			}
+
+			const hasValueChanged = sortedContact.value !== contact[state.orderKey]
+			const hasFavoriteChanged = sortedContact.favorite !== (state.contacts[contact.key].dav?.favorite || false)
+
+			if (hasValueChanged || hasFavoriteChanged) {
 				sortedContact.value = contact[state.orderKey]
-				// and then we sort again
-				state.sortedContacts.sort(sortData)
+				sortedContact.favorite = state.contacts[contact.key].dav?.favorite || false
+
+				state.sortedContacts.sort(sortByFavoriteAndName)
 			}
 		} else {
 			console.error('Error while replacing the following contact', contact)
@@ -215,10 +283,13 @@ const mutations = {
 	 */
 	sortContacts(state) {
 		state.sortedContacts = Object.values(state.contacts)
-			// exclude groups
 			.filter((contact) => contact.kind !== 'group')
-			.map((contact) => { return { key: contact.key, value: contact[state.orderKey] } })
-			.sort(sortData)
+			.map((contact) => ({
+				key: contact.key,
+				value: contact[state.orderKey],
+				favorite: contact.favorite || false,
+			}))
+			.sort(sortByFavoriteAndName)
 	},
 
 	/**
@@ -274,6 +345,33 @@ const getters = {
 
 const actions = {
 
+	/**
+	 * Toggle the favorite state of a contact.
+	 * Updates the store
+	 *
+	 * @param {object} context the store mutations
+	 * @param {object} contact the contact key to toggle
+	 */
+	async toggleFavorite(context, contact) {
+		if (!contact.dav) {
+			throw new Error(`Missing DAV object for contact ${contact.key}`)
+		}
+
+		const oldValue = contact.dav.favorite || false
+		const newValue = !oldValue
+
+		try {
+			contact.dav.favorite = newValue
+			await contact.dav.updateProperties()
+			context.commit('updateContactFavorite', contact)
+		} catch (error) {
+			contact.dav.favorite = oldValue
+			context.commit('updateContactFavorite', contact)
+			showError(t('contacts', 'Could not update favorite state'))
+			console.error('Could not toggle favorite state', error)
+		}
+	},
+
 	/**
 	 * Delete a contact from the list and from the associated addressbook
 	 *
@@ -375,9 +473,17 @@ const actions = {
 		if (etag.trim() !== '') {
 			await context.commit('updateContactEtag', { contact, etag })
 		}
-		return contact.dav.fetchCompleteData(forceReFetch)
+
+		const storeContact = context.getters.getContact(contact.key)
+		const davObject = storeContact?.dav || contact.dav
+
+		const savedFavorite = davObject.favorite
+
+		return davObject.fetchCompleteData(forceReFetch)
 			.then(() => {
-				const newContact = new Contact(contact.dav.data, contact.addressbook)
+				const newContact = new Contact(davObject.data, contact.addressbook)
+				newContact.dav = davObject
+				newContact.dav.favorite = savedFavorite
 				context.commit('updateContact', newContact)
 			})
 			.catch((error) => { throw error })