fix(sortby): resolves issue with sorting of events

fix #1258

Author: marksie1988

src/functions/sort_events.ts

@@ -1,50 +1,24 @@
+import { mdiCurrencyMnt } from '@mdi/js';
 import dayjs from 'dayjs';
 
 import EventClass from '../lib/event.class';
 
 // Function to sort events
-export default function sortEvents(events, config) {
+export default function sortEvents(events: EventClass[], config) {
 	const currentDateTime = dayjs(); // Current date and time
+	const sortedEvents: EventClass[] = [...events]; // Array to manipulate events.
+	const allDayEventsArray: EventClass[] = []; // Array to store the all-day events.
 
-	events.sort((a, b) => {
-		const isRunningA = currentDateTime.isBetween(a.startDateTime, a.endDateTime);
-		const isRunningB = currentDateTime.isBetween(b.startDateTime, b.endDateTime);
-
-		if (isRunningA && !isRunningB) {
-			return -1;
-		} else if (!isRunningA && isRunningB) {
-			return 1;
-		} else {
-			const timeDiffA = Math.min(
-				Math.abs(a.startDateTime.diff(currentDateTime)),
-				Math.abs(a.endDateTime.diff(currentDateTime)),
-			);
-
-			const timeDiffB = Math.min(
-				Math.abs(b.startDateTime.diff(currentDateTime)),
-				Math.abs(b.endDateTime.diff(currentDateTime)),
-			);
-
-			return timeDiffA - timeDiffB;
-		}
-	});
-
-	// Combine sorted all-day and non-all-day events
-	const sortedEvents = [...events];
-
-	// Create an array to store the all day events.
-	const allDayEventsArray: EventClass[] = [];
-
-	// Iterate over the sorted events array and move all of the all day events to the allDayEvents array.
-	for (let i = sortedEvents.length - 1; i >= 0; i--) {
-		const event = sortedEvents[i];
+	// Iterate over the events array and move all all-day events to the allDayEvents array.
+	for (let i = events.length - 1; i >= 0; i--) {
+		const event = events[i];
 		if (event.isAllDayEvent) {
 			allDayEventsArray.push(event);
 			sortedEvents.splice(i, 1);
 		}
 	}
 
-	// Sort the all day events.
+	// Sort the all-day events.
 	allDayEventsArray.sort((a, b) => {
 		if (a.entity !== b.entity) {
 			return a.entity.entity_id.localeCompare(b.entity);
@@ -53,24 +27,76 @@ export default function sortEvents(events, config) {
 		}
 	});
 
-	// If config.allDayBottom is true, add the all day events to the end of the sorted events array.
-	if (config.allDayBottom) {
-		sortedEvents.push(...allDayEventsArray);
-	}
+	if (config.sortBy === 'milestone') {
+		sortedEvents.sort((a, b) => {
+			const aStartDiff = a.startDateTime.diff(currentDateTime);
+			const bStartDiff = b.startDateTime.diff(currentDateTime);
 
-	// Otherwise, add the all day events to the beginning of the sorted events array.
-	else {
-		sortedEvents.unshift(...allDayEventsArray);
-	}
+			if (aStartDiff <= 0 && bStartDiff <= 0) {
+				// Both events have started, sort by their end times
+				const aEndDiff = a.endDateTime.diff(currentDateTime);
+				const bEndDiff = b.endDateTime.diff(currentDateTime);
+
+				if (aEndDiff <= 0 && bEndDiff <= 0) {
+					// Both events are ongoing, sort by their end times
+					return a.endDateTime.diff(b.endDateTime);
+				} else {
+					// One event has finished or is ongoing, prioritize the one finishing sooner
+					return aEndDiff - bEndDiff;
+				}
+			} else {
+				// Sort by the difference between the start time and the current time
+				return aStartDiff - bStartDiff;
+			}
+		});
 
-	if (config.sortBy === 'milestone') {
 		// Move finished events to the bottom when sorting by milestone
 		sortedEvents.sort((a, b) => {
 			if (a.isFinished !== b.isFinished) {
 				return a.isFinished ? 1 : -1;
 			}
+			// If both events are finished, sort them by their endDateTime in ascending order.
+			if (a.isFinished) {
+				return dayjs(a.endDateTime).isBefore(b.endDateTime) ? -1 : 1;
+			}
 			return 0;
 		});
 	}
+
+	// Sort events by their start time, finished events are moved to the bottom.
+	if (config.sortBy === 'start') {
+		sortedEvents.sort((a, b) => {
+			const isRunningA = currentDateTime.isBetween(a.startDateTime, a.endDateTime);
+			const isRunningB = currentDateTime.isBetween(b.startDateTime, b.endDateTime);
+
+			if (isRunningA && !isRunningB) {
+				return -1;
+			} else if (!isRunningA && isRunningB) {
+				return 1;
+			} else {
+				const timeDiffA = Math.min(
+					Math.abs(a.startDateTime.diff(currentDateTime)),
+					Math.abs(a.endDateTime.diff(currentDateTime)),
+				);
+
+				const timeDiffB = Math.min(
+					Math.abs(b.startDateTime.diff(currentDateTime)),
+					Math.abs(b.endDateTime.diff(currentDateTime)),
+				);
+
+				return timeDiffA - timeDiffB;
+			}
+		});
+	}
+
+	// If config.allDayBottom is true, add the all-day events to the end of the sorted events array.
+	if (config.allDayBottom) {
+		sortedEvents.push(...allDayEventsArray);
+	}
+	// Otherwise, add the all-day events to the beginning of the sorted events array.
+	else {
+		sortedEvents.unshift(...allDayEventsArray);
+	}
+
 	return sortedEvents;
 }

src/types/config.ts

@@ -27,7 +27,6 @@ export interface atomicCardConfig extends LovelaceCardConfig {
 	startDaysAhead?: number;
 	showLastCalendarWeek?: boolean;
 	showCalNameInEvent?: boolean;
-	sortByStartTime?: boolean;
 	disableEventLink?: boolean;
 	disableLocationLink?: boolean;
 	linkTarget: string;