feat: event cue (#473)

* feat: parse cue * refactor: get delay from backend * feat: add cue to UI * refactor: remove deprecated delay logic * refactor: extract studio clock specific logic * refactor: extract utilities * refactor: fix issue with missing key * style: prevent cue overflow * style: prevent whitespace wrap * feat: add support for cues in integrations
2026-08-18 21:54:09 +00:00 · 2023-08-17 21:43:11 +02:00
parent 51c31adaf1
commit 657cc22b44
62 changed files with 1363 additions and 1290 deletions
@@ -0,0 +1,80 @@
+import { OntimeEvent, OntimeRundown } from 'ontime-types';
+
+import { getFirstEvent, getNextEvent } from '../rundown-utils/rundownUtils.js';
+import { isNumeric } from '../types/types.js';
+
+/**
+ * Finds if last characters in input are a number and increments
+ * @param input {string}
+ */
+export function getIncrement(input: string): string {
+  // Check if the input string contains a number at the end
+  const match = input.match(/^(\D*)(\d+)(\.\d+)?$/);
+
+  if (match) {
+    // If a number is found, extract the non-numeric prefix, integer part, and decimal part
+    let [, prefix, integerPart, decimalPart] = match;
+
+    if (decimalPart) {
+      if (decimalPart === '.99') {
+        decimalPart = '.100';
+      } else {
+        const addDecimal = '0'.repeat(decimalPart.length - 2) + '1';
+        const incrementedDecimal = (Number(decimalPart) + Number('0.' + addDecimal)).toFixed(decimalPart.length - 1);
+        decimalPart = incrementedDecimal.toString().replace('0.', '.');
+      }
+      return `${prefix}${integerPart}${decimalPart}`;
+    }
+    const incrementedInteger = Number(integerPart) + 1;
+    integerPart = incrementedInteger.toString();
+    return `${prefix}${integerPart}`;
+  }
+  // If no number is found, append "2" to the string and return the updated string
+  return input + '2';
+}
+
+/**
+ * Gets suitable name for a new event cue
+ * @param rundown {OntimeRundown}
+ * @param insertAfterId {string}
+ */
+export function getCueCandidate(rundown: OntimeRundown, insertAfterId?: string): string {
+  function addAtTop() {
+    const firstEventCue = getFirstEvent(rundown)?.cue;
+
+    if (isNumeric(firstEventCue)) {
+      return (Number(firstEventCue) / 10).toString();
+    }
+    return '1';
+  }
+
+  // we did not provide a element to go after, we attempt to go first so only need to check for a cue with value 1
+  if (typeof insertAfterId === 'undefined' || rundown.length === 0) {
+    return addAtTop();
+  }
+
+  const afterIndex = rundown.findIndex((event) => event.id === insertAfterId);
+
+  // we did not find the previous element, insert at top
+  if (afterIndex === -1) {
+    return addAtTop();
+  }
+
+  // get elements around
+  const previousEvent = rundown.at(afterIndex);
+  const nextEvent = getNextEvent(rundown, insertAfterId);
+
+  // try and increment the cue
+  let cue = getIncrement((previousEvent as OntimeEvent).cue);
+
+  // if increment is clashing with next, we add a decimal instead
+  if (cue === nextEvent?.cue) {
+    cue = (previousEvent as OntimeEvent).cue + '.1';
+  }
+
+  return cue;
+}
+
+export function sanitiseCue(cue: string) {
+  return cue.replaceAll(' ', '').replaceAll(',', '.');
+}