cpvalente/ontime
1
0
Fork 0
mirror of https://github.com/cpvalente/ontime.git synced 2026-08-14 03:43:50 +00:00
Code Issues Packages Projects Releases 10 Wiki Activity

refactor: restructure model to contain an object of rundowns

Browse Source
This commit is contained in:
Carlos Valente
2025-03-15 09:04:33 +01:00
committed by arc-alex
parent 0a80d6db31
commit abd9b127db
111 changed files with 4357 additions and 4515 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/utils/src/cue-utils/cueUtils.test.ts
+84 -72
View File
@@ -1,4 +1,4 @@
import type { OntimeDelay, OntimeEvent, OntimeRundown } from 'ontime-types';
import type { OntimeDelay, OntimeEntry, OntimeEvent, RundownEntries } from 'ontime-types';
import { SupportedEvent } from 'ontime-types';
import { getCueCandidate, getIncrement, sanitiseCue } from './cueUtils.js';
@@ -36,76 +36,83 @@ describe('getIncrement()', () => {
describe('getCueCandidate()', () => {
describe('in the beginning of the rundown', () => {
it('names cue as 1 if next event does not collide', () => {
const testRundown = [
{ id: '1', cue: '10', type: SupportedEvent.Event },
{ id: '2', cue: '11', type: SupportedEvent.Event },
] as OntimeRundown;
const cue = getCueCandidate(testRundown);
const entries: RundownEntries = {
'1': { id: '1', cue: '10', type: SupportedEvent.Event } as OntimeEvent,
'2': { id: '2', cue: '11', type: SupportedEvent.Event } as OntimeEvent,
};
const cue = getCueCandidate(entries, ['1', '2']);
expect(cue).toBe('1');
});
it('creates decimal stem if next cue is 1', () => {
const testRundown = [
{ id: '1', cue: '1', type: SupportedEvent.Event },
{ id: '2', cue: '10', type: SupportedEvent.Event },
] as OntimeRundown;
const cue = getCueCandidate(testRundown);
const entries: RundownEntries = {
'1': { id: '1', cue: '1', type: SupportedEvent.Event } as OntimeEvent,
'2': { id: '2', cue: '10', type: SupportedEvent.Event } as OntimeEvent,
};
const cue = getCueCandidate(entries, ['1', '2']);
expect(cue).toBe('0.1');
});
});
describe('in the middle of the rundown', () => {
it('names cue as an increment if next event has different stem (case of numbers)', () => {
const testRundown = [
{ id: '1', cue: '1', type: SupportedEvent.Event },
{ id: '2', cue: '10', type: SupportedEvent.Event },
] as OntimeRundown;
const cue = getCueCandidate(testRundown, '1');
const entries: RundownEntries = {
'1': { id: '1', cue: '1', type: SupportedEvent.Event } as OntimeEvent,
'2': { id: '2', cue: '10', type: SupportedEvent.Event } as OntimeEvent,
};
const cue = getCueCandidate(entries, ['1', '2'], '1');
expect(cue).toBe('2');
});
it('names cue as an increment if next event has different stem (case of letters)', () => {
const testRundown = [
{ id: '1', cue: 'Presenter', type: SupportedEvent.Event },
{
const entries: RundownEntries = {
'1': { id: '1', cue: 'Presenter', type: SupportedEvent.Event } as OntimeEvent,
'2': {
id: '2',
cue: 'Interval',
type: SupportedEvent.Event,
},
] as OntimeRundown;
const cue = getCueCandidate(testRundown, '1');
} as OntimeEntry,
};
const cue = getCueCandidate(entries, ['1', '2'], '1');
expect(cue).toBe('Presenter2');
});
it('creates decimal stem if next cue has same stem (case of numbers)', () => {
const testRundown = [
{ id: '1', cue: '1', type: SupportedEvent.Event },
{ id: '2', cue: '2', type: SupportedEvent.Event },
] as OntimeRundown;
const cue = getCueCandidate(testRundown, '1');
const entries: RundownEntries = {
'1': { id: '1', cue: '1', type: SupportedEvent.Event } as OntimeEvent,
'2': { id: '2', cue: '2', type: SupportedEvent.Event } as OntimeEvent,
};
const cue = getCueCandidate(entries, ['1', '2'], '1');
expect(cue).toBe('1.1');
});
it('creates decimal stem if next cue has same stem (case of letters)', () => {
const testRundown = [
{ id: '1', cue: 'Presenter1', type: SupportedEvent.Event },
{ id: '2', cue: 'Presenter2', type: SupportedEvent.Event },
] as OntimeRundown;
const cue = getCueCandidate(testRundown, '1');
const entries: RundownEntries = {
'1': { id: '1', cue: 'Presenter1', type: SupportedEvent.Event } as OntimeEvent,
'2': { id: '2', cue: 'Presenter2', type: SupportedEvent.Event } as OntimeEvent,
};
const cue = getCueCandidate(entries, ['1', '2'], '1');
expect(cue).toBe('Presenter1.1');
});
});
describe('considers edge cases', () => {
it('previousEvent might not be a cue', () => {
const testRundown = [
{ id: '1', cue: '10', type: SupportedEvent.Event } as OntimeEvent,
{ id: '2', type: SupportedEvent.Delay } as OntimeDelay,
];
const cue = getCueCandidate(testRundown, '2');
const entries: RundownEntries = {
'1': { id: '1', cue: '10', type: SupportedEvent.Event } as OntimeEvent,
'2': { id: '2', type: SupportedEvent.Delay } as OntimeDelay,
};
const cue = getCueCandidate(entries, ['1', '2'], '2');
expect(cue).toBe('11');
});
});
it('there might not be events before', () => {
const testRundown = [
{ id: '1', type: SupportedEvent.Delay } as OntimeDelay,
{ id: '2', type: SupportedEvent.Delay } as OntimeDelay,
];
const cue = getCueCandidate(testRundown, '2');
const entries: RundownEntries = {
'1': { id: '1', type: SupportedEvent.Delay } as OntimeDelay,
'2': { id: '2', type: SupportedEvent.Delay } as OntimeDelay,
};
const cue = getCueCandidate(entries, ['1', '2'], '2');
expect(cue).toBe('1');
});
});
@@ -113,53 +120,58 @@ describe('getCueCandidate()', () => {
describe('findCueName() with mixed events', () => {
describe('in the beginning of the rundown', () => {
it('names cue as 1 if next event does not collide', () => {
const testRundown = [
{ id: '1', cue: '10', type: SupportedEvent.Event },
{ id: '2', cue: '11', type: SupportedEvent.Event },
] as OntimeRundown;
const cue = getCueCandidate(testRundown);
const entries: RundownEntries = {
'1': { id: '1', cue: '10', type: SupportedEvent.Event } as OntimeEvent,
'2': { id: '2', cue: '11', type: SupportedEvent.Event } as OntimeEvent,
};
const cue = getCueCandidate(entries, ['1', '2']);
expect(cue).toBe('1');
});
it('creates decimal stem if next cue is 1', () => {
const testRundown = [
{ id: '1', cue: '1', type: SupportedEvent.Event },
{ id: '2', cue: '10', type: SupportedEvent.Event },
] as OntimeRundown;
const cue = getCueCandidate(testRundown);
const entries: RundownEntries = {
'1': { id: '1', cue: '1', type: SupportedEvent.Event } as OntimeEvent,
'2': { id: '2', cue: '10', type: SupportedEvent.Event } as OntimeEvent,
};
const cue = getCueCandidate(entries, ['1', '2']);
expect(cue).toBe('0.1');
});
});
describe('in the middle of the rundown', () => {
it('names cue as an increment if next event has different stem (case of numbers)', () => {
const testRundown = [
{ id: '1', cue: '1', type: SupportedEvent.Event },
{ id: '2', cue: '10', type: SupportedEvent.Event },
] as OntimeRundown;
const cue = getCueCandidate(testRundown, '1');
const entries: RundownEntries = {
'1': { id: '1', cue: '1', type: SupportedEvent.Event } as OntimeEvent,
'2': { id: '2', cue: '10', type: SupportedEvent.Event } as OntimeEvent,
};
const cue = getCueCandidate(entries, ['1', '2'], '1');
expect(cue).toBe('2');
});
it('names cue as an increment if next event has different stem (case of letters)', () => {
const testRundown = [
{ id: '1', cue: 'Presenter', type: SupportedEvent.Event },
{ id: '2', cue: 'Interval', type: SupportedEvent.Event },
] as OntimeRundown;
const cue = getCueCandidate(testRundown, '1');
const entries: RundownEntries = {
'1': { id: '1', cue: 'Presenter', type: SupportedEvent.Event } as OntimeEvent,
'2': { id: '2', cue: 'Interval', type: SupportedEvent.Event } as OntimeEvent,
};
const cue = getCueCandidate(entries, ['1', '2'], '1');
expect(cue).toBe('Presenter2');
});
it('creates decimal stem if next cue has same stem (case of numbers)', () => {
const testRundown = [
{ id: '1', cue: '1', type: SupportedEvent.Event },
{ id: '2', cue: '2', type: SupportedEvent.Event },
] as OntimeRundown;
const cue = getCueCandidate(testRundown, '1');
const entries: RundownEntries = {
'1': { id: '1', cue: '1', type: SupportedEvent.Event } as OntimeEvent,
'2': { id: '2', cue: '2', type: SupportedEvent.Event } as OntimeEvent,
};
const cue = getCueCandidate(entries, ['1', '2'], '1');
expect(cue).toBe('1.1');
});
it('creates decimal stem if next cue has same stem (case of letters)', () => {
const testRundown = [
{ id: '1', cue: 'Presenter1', type: SupportedEvent.Event },
{ id: '2', cue: 'Presenter2', type: SupportedEvent.Event },
] as OntimeRundown;
const cue = getCueCandidate(testRundown, '1');
const entries: RundownEntries = {
'1': { id: '1', cue: 'Presenter1', type: SupportedEvent.Event } as OntimeEvent,
'2': { id: '2', cue: 'Presenter2', type: SupportedEvent.Event } as OntimeEvent,
};
const cue = getCueCandidate(entries, ['1', '2'], '1');
expect(cue).toBe('Presenter1.1');
});
});
packages/utils/src/cue-utils/cueUtils.ts
+48 -47
View File
@@ -1,7 +1,7 @@
import type { OntimeEvent, OntimeRundown, OntimeRundownEntry } from 'ontime-types';
import type { EntryId, OntimeEntry, RundownEntries } from 'ontime-types';
import { isOntimeEvent } from 'ontime-types';
import { getFirstEvent, getNextEvent, getPreviousEvent } from '../rundown-utils/rundownUtils.js';
import { getFirstEventNormal, getNextEventNormal, getPreviousEventNormal } from '../rundown-utils/rundownUtils.js';
import { isNumeric } from '../types/types.js';
// Zero or more non-digit characters at the beginning ((\D*)).
@@ -11,7 +11,6 @@ const regex = /^(\D*)(\d+)(\.\d+)?$/;
/**
* 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
@@ -41,55 +40,57 @@ export function getIncrement(input: string): string {
/**
* 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).firstEvent?.cue;
export function getCueCandidate(entries: RundownEntries, order: EntryId[], insertAfterId?: string): string {
// 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 (insertAfterId === undefined || order.length === 0) {
return addAtTop();
}
if (isNumeric(firstEventCue)) {
return (Number(firstEventCue) / 10).toString();
// get the given event, or any before that
let previousEvent: OntimeEntry | null | undefined = entries[insertAfterId];
if (!isOntimeEvent(previousEvent)) {
previousEvent = getPreviousEventNormal(entries, order, insertAfterId).previousEvent;
if (!isOntimeEvent(previousEvent)) {
return addAtTop();
}
}
// the cue is based on the previous event cue
const cue = getIncrement(previousEvent.cue);
const { nextEvent } = getNextEventNormal(entries, order, insertAfterId);
// if increment is clashing with next, we add a decimal instead
if (cue !== nextEvent?.cue) {
return cue;
}
// there is a clash, bt the cue is a pure number
if (isNumeric(cue)) {
return incrementDecimal(previousEvent.cue);
}
/**
* at this point, we know the cue is not numeric
* but the increment failed, so we have a numeric ending
* eg. Presenter 1 .... Presenter 2 -> Presenter1.1
* eg. Presenter 1.1 .... Presenter 1.2 -> Presenter1.1.1
*/
return `${previousEvent.cue}.1`;
function incrementDecimal(cue: string) {
const n = Number(cue);
return (n + 0.1).toString();
}
function addAtTop() {
const firstEventCue = getFirstEventNormal(entries, order).firstEvent?.cue;
if (firstEventCue === '1') {
return '0.1';
}
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
let previousEvent: OntimeRundownEntry | undefined | null | OntimeEvent = rundown.at(afterIndex);
if (!isOntimeEvent(previousEvent)) {
previousEvent = getPreviousEvent(rundown, insertAfterId).previousEvent as null | OntimeEvent;
}
let cue = '1';
const { nextEvent } = getNextEvent(rundown, insertAfterId);
// try and increment the cue
if (isOntimeEvent(previousEvent)) {
cue = getIncrement(previousEvent.cue);
}
// if increment is clashing with next, we add a decimal instead
if (cue === nextEvent?.cue) {
if (previousEvent === null) {
cue = '0.1';
} else {
cue = `${previousEvent.cue}.1`;
}
}
return cue;
}
export function sanitiseCue(cue: string) {