mirror of
https://github.com/cpvalente/ontime.git
synced 2026-09-01 04:19:12 +00:00
feat(countdown): allow counting down to a group
This commit is contained in:
@@ -1,4 +1,17 @@
|
||||
import { EntryId, MaybeNumber, OffsetMode, OntimeEntry, OntimeEvent, OntimeReport, Playback } from 'ontime-types';
|
||||
import {
|
||||
EntryId,
|
||||
MaybeNumber,
|
||||
OffsetMode,
|
||||
OntimeEntry,
|
||||
OntimeEvent,
|
||||
OntimeGroup,
|
||||
OntimeReport,
|
||||
Playback,
|
||||
PlayableEvent,
|
||||
isOntimeEvent,
|
||||
isOntimeGroup,
|
||||
isPlayableEvent,
|
||||
} from 'ontime-types';
|
||||
import { MILLIS_PER_MINUTE, getExpectedStart, millisToString, removeLeadingZero } from 'ontime-utils';
|
||||
|
||||
import { useCountdownSocket } from '../../common/hooks/useSocket';
|
||||
@@ -40,7 +53,7 @@ export const timerProgress: TimerMessage = {
|
||||
* Handles events in different days but disregards whether an event has actually played
|
||||
*/
|
||||
export function useSubscriptionDisplayData(
|
||||
subscribedEvent: ExtendedEntry<OntimeEvent> & { endedAt: MaybeNumber; expectedStart: number },
|
||||
subscribedEvent: CountdownTarget & { endedAt: MaybeNumber; expectedStart: number },
|
||||
): { status: ProgressStatus; statusDisplay: string; timeDisplay: string } {
|
||||
const { playback, current, clock } = useCountdownSocket();
|
||||
const { getLocalizedString } = useTranslation();
|
||||
@@ -67,7 +80,11 @@ export function useSubscriptionDisplayData(
|
||||
|
||||
return {
|
||||
status: 'live',
|
||||
statusDisplay: getLocalizedString(timerProgress['live']),
|
||||
statusDisplay: getLocalizedString(
|
||||
subscribedEvent.parent || (subscribedEvent.isGroup && subscribedEvent.liveEntry)
|
||||
? 'countdown.group_running'
|
||||
: timerProgress['live'],
|
||||
),
|
||||
timeDisplay: bigDuration(current ?? 0),
|
||||
};
|
||||
}
|
||||
@@ -168,10 +185,75 @@ export function isOutsideRange(a: number, b: number): boolean {
|
||||
return Math.abs(a - b) > MILLIS_PER_MINUTE;
|
||||
}
|
||||
|
||||
export type CountdownEvent = ExtendedEntry<OntimeEvent> & { expectedStart: number; endedAt: MaybeNumber };
|
||||
/**
|
||||
* A subscription target normalised to the event-shaped object the countdown display consumes.
|
||||
* For events this is a pass-through; for groups it carries the group identity and display data
|
||||
* while deriving timing from the group's first playable child (see resolveSubscriptionTarget).
|
||||
*/
|
||||
export type CountdownTarget = ExtendedEntry<OntimeEvent> & {
|
||||
isGroup?: boolean;
|
||||
targetId?: EntryId; // child entry used for countdown/live/armed state checks
|
||||
reportId?: EntryId; // entry used for the report lookup (e.g. last child of a group)
|
||||
liveEntry?: ExtendedEntry<OntimeEvent> | null; // the running child while a group is live
|
||||
};
|
||||
|
||||
export type CountdownEvent = CountdownTarget & { expectedStart: number; endedAt: MaybeNumber };
|
||||
|
||||
/**
|
||||
* Resolves a subscription (event or group) into an event-shaped countdown target.
|
||||
* - Events are returned unchanged.
|
||||
* - Groups count down to their first playable child while displaying the group identity.
|
||||
* Status is group-aware: live while any child is loaded, past only once the whole group has finished.
|
||||
* Returns null when a group has no playable children (nothing to count down to).
|
||||
*/
|
||||
export function resolveSubscriptionTarget(
|
||||
entry: ExtendedEntry<OntimeEvent | OntimeGroup>,
|
||||
flatRundown: ExtendedEntry<OntimeEntry>[],
|
||||
): CountdownTarget | null {
|
||||
if (!isOntimeGroup(entry)) {
|
||||
return entry;
|
||||
}
|
||||
|
||||
const children = flatRundown.filter(
|
||||
(item): item is ExtendedEntry<PlayableEvent> =>
|
||||
isOntimeEvent(item) && isPlayableEvent(item) && item.parent === entry.id,
|
||||
);
|
||||
|
||||
if (children.length === 0) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const firstChild = children[0];
|
||||
const lastChild = children[children.length - 1];
|
||||
const liveEntry = children.find((child) => child.isLoaded) ?? null;
|
||||
const isLoaded = liveEntry !== null;
|
||||
const isPast = !isLoaded && lastChild.isPast;
|
||||
|
||||
return {
|
||||
// timing derives from the first playable child
|
||||
...firstChild,
|
||||
// group identity and display data
|
||||
id: entry.id,
|
||||
parent: null,
|
||||
title: entry.title,
|
||||
colour: entry.colour,
|
||||
note: entry.note,
|
||||
custom: entry.custom,
|
||||
duration: entry.duration,
|
||||
countToEnd: false,
|
||||
// group-aware status
|
||||
isLoaded,
|
||||
isPast,
|
||||
// group markers
|
||||
isGroup: true,
|
||||
targetId: firstChild.id,
|
||||
reportId: lastChild.id,
|
||||
liveEntry,
|
||||
};
|
||||
}
|
||||
|
||||
export function extendEventData(
|
||||
event: ExtendedEntry<OntimeEvent>,
|
||||
event: CountdownTarget,
|
||||
currentDay: number,
|
||||
actualStart: MaybeNumber,
|
||||
plannedStart: MaybeNumber,
|
||||
@@ -189,6 +271,6 @@ export function extendEventData(
|
||||
offset,
|
||||
mode,
|
||||
});
|
||||
const { endedAt } = reportData[event.id] ?? { endedAt: null };
|
||||
const { endedAt } = reportData[event.reportId ?? event.id] ?? { endedAt: null };
|
||||
return { ...event, expectedStart, endedAt };
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user