feat: count to group completion

packages/types/src/definitions/core/OntimeEntry.ts

@@ -44,6 +44,8 @@ export type OntimeGroup = OntimeBaseEvent & {
   note: string;
   entries: EntryId[];
   targetDuration: MaybeNumber;
+  useGroupTimer: boolean;
+  timerType: TimerType;
   colour: string;
   custom: EntryCustomFields;
   // !==== RUNTIME METADATA ====! //

packages/types/src/definitions/runtime/RuntimeStore.ts

@@ -17,6 +17,7 @@ export const runtimeStorePlaceholder: Readonly<RuntimeStore> = {
     secondaryTimer: null, // change on every update
     startedAt: null, // change can only be initiated by user
   },
+  groupTimer: null,
   message: {
     timer: {
       text: '',

packages/types/src/definitions/runtime/RuntimeStore.type.ts

@@ -9,6 +9,7 @@ export type RuntimeStore = {
   // timer data
   clock: number;
   timer: TimerState;
+  groupTimer: TimerState | null;
 
   // messages service
   message: MessageState;

packages/utils/index.ts

@@ -34,7 +34,14 @@ export {
   group as groupDef,
   milestone as milestoneDef,
 } from './src/rundown-utils/entryDefinitions.js';
-export { createDelay, createEvent, createGroup, createMilestone, makeString } from './src/rundown-utils/entryUtils.js';
+export {
+  createDelay,
+  createEvent,
+  createGroup,
+  createMilestone,
+  makeString,
+  validateGroupTimerType,
+} from './src/rundown-utils/entryUtils.js';
 
 // time format utils
 export {

packages/utils/src/rundown-utils/entryDefinitions.ts

@@ -52,6 +52,8 @@ export const group: Omit<OntimeGroup, 'id'> = {
   note: '',
   entries: [],
   targetDuration: null,
+  useGroupTimer: false,
+  timerType: TimerType.CountDown,
   colour: '',
   custom: {},
   // !==== RUNTIME METADATA ====! //

packages/utils/src/rundown-utils/entryUtils.ts

@@ -1,5 +1,5 @@
 import type { OntimeDelay, OntimeEvent, OntimeGroup, OntimeMilestone } from 'ontime-types';
-import { SupportedEntry, TimeStrategy } from 'ontime-types';
+import { SupportedEntry, TimeStrategy, TimerType } from 'ontime-types';
 
 import { generateId } from '../generate-id/generateId.js';
 import { validateEndAction, validateTimerType } from '../validate-events/validateEvent.js';
@@ -67,6 +67,8 @@ export function createGroup(patch?: Partial<OntimeGroup>): OntimeGroup {
     note: patch.note ?? '',
     entries: patch.entries ?? [],
     targetDuration: patch.targetDuration ?? null,
+    useGroupTimer: patch.useGroupTimer === true,
+    timerType: validateGroupTimerType(patch.timerType),
     colour: makeString(patch.colour, ''),
     custom: patch.custom ?? {},
     revision: 0,
@@ -77,6 +79,16 @@ export function createGroup(patch?: Partial<OntimeGroup>): OntimeGroup {
   };
 }
 
+export function validateGroupTimerType(
+  value: unknown,
+  fallback: unknown = TimerType.CountDown,
+): TimerType.CountDown | TimerType.CountUp {
+  if (value === TimerType.CountDown || value === TimerType.CountUp) {
+    return value;
+  }
+  return fallback === TimerType.CountUp ? TimerType.CountUp : TimerType.CountDown;
+}
+
 /**
  * Creates a new milestone from an optional patch
  */