Fix integration api (#1866)

* allow change api to set flag and countToEnd

* fix: custom fields can be uppercase

* check that prop exists and add target duration for group
This commit is contained in:
Alex Christoffer Rasmussen
2025-11-09 14:36:13 +01:00
committed by GitHub
parent 15f3b9625c
commit cee3c9c070
2 changed files with 21 additions and 10 deletions
@@ -24,6 +24,7 @@ import { throttle } from '../utils/throttle.js';
import { coerceEnum } from '../utils/coerceType.js';
import { editEntry } from '../api-data/rundown/rundown.service.js';
import { willCauseRegeneration } from '../api-data/rundown/rundown.utils.js';
import { getCurrentRundown } from '../api-data/rundown/rundown.dao.js';
const throttledEditEvent = throttle(editEntry, 20);
let lastRequest: Date | null = null;
@@ -63,32 +64,39 @@ const actionHandlers: Record<ApiActionTag, ActionHandler> = {
throw new Error('Missing Event ID');
}
const { entries } = getCurrentRundown();
const targetEntry = entries[id];
if (!targetEntry) {
throw new Error('ID do not exits in rundown');
}
const data = payload[id as keyof typeof payload];
const patchEvent: PatchWithId<OntimeEvent> = { id };
const patchEntry: PatchWithId<OntimeEvent> = { id }; // It is not necessarily an event could also be milestone or group but we don't need to track that in the typing here
let shouldThrottle = false;
Object.entries(data).forEach(([property, value]) => {
if (typeof property !== 'string' || value === undefined) {
if (typeof property !== 'string' || value === undefined || !(property in targetEntry)) {
throw new Error('Invalid property or value');
}
// parseProperty is async because of the data lock
const newObjectProperty = parseProperty(property, value);
const key = Object.keys(newObjectProperty)[0] as keyof OntimeEvent;
const key = Object.keys(newObjectProperty)[0];
shouldThrottle = shouldThrottle || willCauseRegeneration(key);
if (patchEvent.custom && newObjectProperty.custom) {
Object.assign(patchEvent.custom, newObjectProperty.custom);
if (patchEntry.custom && newObjectProperty.custom) {
Object.assign(patchEntry.custom, newObjectProperty.custom);
} else {
Object.assign(patchEvent, newObjectProperty);
Object.assign(patchEntry, newObjectProperty);
}
});
if (shouldThrottle) {
if (throttledEditEvent(patchEvent)) {
if (throttledEditEvent(patchEntry)) {
return { payload: 'throttled' };
}
} else {
editEntry(patchEvent).catch((_error) => {
editEntry(patchEntry).catch((_error) => {
/** No error handling */
});
}
@@ -16,12 +16,14 @@ function clampDuration(value: number): number {
return value;
}
const propertyConversion = {
const propertyConversion: Record<string, (value: unknown) => unknown> = {
title: coerceString,
note: coerceString,
cue: coerceString,
skip: coerceBoolean,
flag: coerceBoolean,
countToEnd: coerceBoolean,
colour: coerceColour,
@@ -36,6 +38,7 @@ const propertyConversion = {
linkStart: coerceBoolean,
timeStrategy: (value: unknown) => coerceEnum<TimeStrategy>(value, TimeStrategy),
targetDuration: (value: unknown) => clampDuration(coerceNumber(value)), // only exist in the group
duration: (value: unknown) => clampDuration(coerceNumber(value)),
timeStart: (value: unknown) => clampDuration(coerceNumber(value)),
timeEnd: (value: unknown) => clampDuration(coerceNumber(value)),
@@ -43,7 +46,7 @@ const propertyConversion = {
export function parseProperty(property: string, value: unknown) {
if (property.startsWith('custom:')) {
const customKey = property.split(':')[1].toLocaleLowerCase(); // all custom fields keys are lowercase
const customKey = property.split(':')[1];
const customFields = getDataProvider().getCustomFields();
if (!(customKey in customFields)) {
throw new Error(`Custom field ${customKey} not found`);