Compare commits

..

1 Commits

Author SHA1 Message Date
Claude 767b567bba Improve editor settings navigation, UX, and visual design
- Unsaved changes guard: confirm dialog when navigating away from dirty forms (GeneralSettings, ProjectData, ViewSettings, ServerPortSettings, AutomationSettingsForm)
- Sticky breadcrumb header: replaces floating close button with a sticky top bar showing current panel › section context
- Scroll-to-sidebar sync: IntersectionObserver in useScrollIntoView feeds active scroll section back into sidebar secondary item highlights
- Rich empty states: ClientList now shows friendly messages for empty Ontime/Other client tables
- Sidebar styling: distinct background, right border, left-accent active indicator (VS Code style)
- Card elevation: raised opacity + box-shadow for visible depth hierarchy
- Border radius: 8px cards and 6px sidebar items using existing theme variable

https://claude.ai/code/session_017jeJF78B4eXcpXAj7KGmnF
2026-05-28 06:51:24 +00:00
82 changed files with 1081 additions and 1863 deletions
+2 -10
View File
@@ -15,10 +15,6 @@ jobs:
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v6
- uses: actions/setup-node@v6
with:
node-version-file: '.nvmrc'
- name: Setup pnpm - name: Setup pnpm
uses: pnpm/action-setup@v6 uses: pnpm/action-setup@v6
@@ -58,10 +54,6 @@ jobs:
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v6
- uses: actions/setup-node@v6
with:
node-version-file: '.nvmrc'
- name: Setup pnpm - name: Setup pnpm
uses: pnpm/action-setup@v6 uses: pnpm/action-setup@v6
@@ -89,11 +81,11 @@ jobs:
key: ${{ runner.os }}-playwright-${{ env.PLAYWRIGHT_VERSION }} key: ${{ runner.os }}-playwright-${{ env.PLAYWRIGHT_VERSION }}
restore-keys: | restore-keys: |
${{ runner.os }}-playwright- ${{ runner.os }}-playwright-
- run: pnpm playwright install --with-deps - run: npx playwright install --with-deps
if: steps.playwright-cache.outputs.cache-hit != 'true' if: steps.playwright-cache.outputs.cache-hit != 'true'
- name: Install Playwright Browsers - name: Install Playwright Browsers
run: pnpm playwright install --with-deps run: npx playwright install --with-deps
- name: Run Playwright tests - name: Run Playwright tests
run: pnpm e2e run: pnpm e2e
+1 -1
View File
@@ -1 +1 @@
v22.22.3 v22.22.2
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "@getontime/cli", "name": "@getontime/cli",
"version": "4.9.0", "version": "4.8.0",
"author": "Carlos Valente", "author": "Carlos Valente",
"description": "Time keeping for live events", "description": "Time keeping for live events",
"repository": "https://github.com/cpvalente/ontime", "repository": "https://github.com/cpvalente/ontime",
+16 -16
View File
@@ -1,10 +1,10 @@
{ {
"name": "ontime-ui", "name": "ontime-ui",
"version": "4.9.0", "version": "4.8.0",
"private": true, "private": true,
"type": "module", "type": "module",
"dependencies": { "dependencies": {
"@base-ui/react": "1.6.0", "@base-ui/react": "1.3.0",
"@codemirror/commands": "^6.0.0", "@codemirror/commands": "^6.0.0",
"@codemirror/lang-css": "^6.0.0", "@codemirror/lang-css": "^6.0.0",
"@codemirror/state": "^6.0.0", "@codemirror/state": "^6.0.0",
@@ -12,27 +12,27 @@
"@dnd-kit/core": "^6.3.1", "@dnd-kit/core": "^6.3.1",
"@dnd-kit/sortable": "^10.0.0", "@dnd-kit/sortable": "^10.0.0",
"@dnd-kit/utilities": "^3.2.2", "@dnd-kit/utilities": "^3.2.2",
"@fontsource/open-sans": "^5.2.7", "@fontsource/open-sans": "^5.2.6",
"@mantine/hooks": "^8.3.7", "@mantine/hooks": "^8.3.7",
"@sentry/react": "^10.59.0", "@sentry/react": "^10.2.0",
"@table-nav/react": "^0.0.7", "@table-nav/react": "^0.0.7",
"@tanstack/react-query": "^5.101.0", "@tanstack/react-query": "^5.85.9",
"@tanstack/react-query-devtools": "^5.101.0", "@tanstack/react-query-devtools": "^5.85.9",
"@tanstack/react-table": "^8.21.3", "@tanstack/react-table": "^8.21.3",
"@uiw/codemirror-theme-vscode": "^4.25.10", "@uiw/codemirror-theme-vscode": "^4.25.9",
"autosize": "^6.0.1", "autosize": "^6.0.1",
"axios": "^1.18.0", "axios": "^1.12.2",
"csv-stringify": "^6.6.0", "csv-stringify": "^6.6.0",
"qrcode": "^1.5.4", "qrcode": "^1.5.4",
"react": "^19.2.7", "react": "^19.2.3",
"react-colorful": "^5.7.0", "react-colorful": "^5.6.1",
"react-dom": "^19.2.7", "react-dom": "^19.2.3",
"react-fast-compare": "^3.2.2", "react-fast-compare": "^3.2.2",
"react-hook-form": "^7.80.0", "react-hook-form": "^7.72.0",
"react-icons": "5.6.0", "react-icons": "5.5.0",
"react-router": "^8.0.1", "react-router": "^7.11.0",
"react-virtuoso": "^4.18.7", "react-virtuoso": "^4.17.0",
"zustand": "^5.0.14" "zustand": "^5.0.9"
}, },
"scripts": { "scripts": {
"addversion": "node -p \"'export const ONTIME_VERSION = ' + JSON.stringify(require('../../package.json').version) + ';'\" > src/ONTIME_VERSION.js", "addversion": "node -p \"'export const ONTIME_VERSION = ' + JSON.stringify(require('../../package.json').version) + ';'\" > src/ONTIME_VERSION.js",
+11 -22
View File
@@ -34,17 +34,19 @@ export async function fetchCurrentRundown(options?: RequestOptions): Promise<Run
throw new Error('Invalid rundown payload'); throw new Error('Invalid rundown payload');
} }
return res.data; return res.data;
}
/** function isValidRundown(x: any): x is Rundown {
* HTTP request to fetch all entries in the given rundown return (
*/ x &&
export async function fetchRundown(rundownId: RundownId, options?: RequestOptions): Promise<Rundown> { typeof x === 'object' &&
const res = await axios.get(`${rundownPath}/${rundownId}`, { signal: options?.signal }); typeof x.id === 'string' &&
if (!isValidRundown(res.data)) { Array.isArray(x.order) &&
throw new Error('Invalid rundown payload'); Array.isArray(x.flatOrder) &&
x.entries &&
typeof x.entries === 'object' &&
typeof x.revision === 'number'
);
} }
return res.data;
} }
/** /**
@@ -195,16 +197,3 @@ export async function requestDeleteAll(rundownId: RundownId): Promise<AxiosRespo
} }
// #endregion operations on rundown entries ======================= // #endregion operations on rundown entries =======================
function isValidRundown(x: any): x is Rundown {
return (
x &&
typeof x === 'object' &&
typeof x.id === 'string' &&
Array.isArray(x.order) &&
Array.isArray(x.flatOrder) &&
x.entries &&
typeof x.entries === 'object' &&
typeof x.revision === 'number'
);
}
@@ -3,8 +3,8 @@ import { ChangeEvent, KeyboardEvent, RefObject, useCallback, useEffect, useMemo,
interface UseReactiveTextInputReturn { interface UseReactiveTextInputReturn {
value: string; value: string;
onChange: (event: ChangeEvent<HTMLInputElement | HTMLTextAreaElement>) => void; onChange: (event: ChangeEvent) => void;
onBlur: (event: ChangeEvent<HTMLInputElement | HTMLTextAreaElement>) => void; onBlur: (event: ChangeEvent) => void;
onKeyDown: (event: KeyboardEvent<HTMLElement>) => void; onKeyDown: (event: KeyboardEvent<HTMLElement>) => void;
} }
@@ -15,9 +15,7 @@ export default function useReactiveTextInput(
options?: { options?: {
submitOnEnter?: boolean; submitOnEnter?: boolean;
submitOnCtrlEnter?: boolean; submitOnCtrlEnter?: boolean;
submitOnTab?: boolean;
onCancelUpdate?: () => void; onCancelUpdate?: () => void;
onTabCancel?: () => void;
allowSubmitSameValue?: boolean; allowSubmitSameValue?: boolean;
allowKeyboardNavigation?: boolean; allowKeyboardNavigation?: boolean;
}, },
@@ -25,10 +23,6 @@ export default function useReactiveTextInput(
const [text, setText] = useState<string>(initialText); const [text, setText] = useState<string>(initialText);
// track whether we are submitting via a submit key (eg enter) and avoid submitting again on blur // track whether we are submitting via a submit key (eg enter) and avoid submitting again on blur
const isKeyboardSubmitting = useRef(false); const isKeyboardSubmitting = useRef(false);
// track escape to prevent the subsequent blur from submitting
const isEscaping = useRef(false);
// track tab-out to prevent blur from submitting (used by timer cells)
const isTabbing = useRef(false);
useEffect(() => { useEffect(() => {
if (typeof initialText === 'undefined') { if (typeof initialText === 'undefined') {
@@ -84,7 +78,6 @@ export default function useReactiveTextInput(
* @param {string} valueToSubmit * @param {string} valueToSubmit
*/ */
const handleEscape = useCallback(() => { const handleEscape = useCallback(() => {
isEscaping.current = true;
// No need to update if it hasn't changed // No need to update if it hasn't changed
setText(initialText); setText(initialText);
// force the text to be the initial value // force the text to be the initial value
@@ -148,30 +141,16 @@ export default function useReactiveTextInput(
event.stopPropagation(); event.stopPropagation();
} }
// for cells that opt out of tab-submit, track tab-out without preventing navigation
if (event.key === 'Tab' && options?.submitOnTab === false) {
isTabbing.current = true;
}
hotKeyHandler(event); hotKeyHandler(event);
}; };
}, [handleEscape, handleSubmit, options?.submitOnCtrlEnter, options?.submitOnEnter, options?.submitOnTab, text]); }, [handleEscape, handleSubmit, options?.submitOnCtrlEnter, options?.submitOnEnter, text]);
return { return {
value: text, value: text,
onChange: (event) => handleChange(event.target.value), onChange: (event: ChangeEvent) => handleChange((event.target as HTMLInputElement).value),
onBlur: (event) => { onBlur: (event: ChangeEvent) => {
if (isTabbing.current) {
isTabbing.current = false;
(options?.onTabCancel ?? options?.onCancelUpdate)?.();
return;
}
if (isEscaping.current) {
isEscaping.current = false;
return;
}
if (!isKeyboardSubmitting.current) { if (!isKeyboardSubmitting.current) {
handleSubmit(event.target.value); handleSubmit((event.target as HTMLInputElement).value);
} }
}, },
onKeyDown: keyHandler, onKeyDown: keyHandler,
@@ -8,12 +8,9 @@
padding-top: 10vh; padding-top: 10vh;
} }
.inline { .empty {
display: flex; width: 100%;
align-items: center; opacity: 0.8;
justify-content: center;
gap: 1rem;
margin-top: 1em;
} }
.text { .text {
@@ -1,33 +1,18 @@
import { SupportedEntry } from 'ontime-types'; import EmptyImage from '../../../assets/images/empty.svg?react';
import { IoAdd } from 'react-icons/io5';
import { useTranslation } from '../../../translation/TranslationProvider';
import Button from '../buttons/Button';
import Empty from './Empty';
import style from './EmptyTableBody.module.scss'; import style from './EmptyTableBody.module.scss';
interface EmptyTableBodyProps { interface EmptyTableBodyProps {
handleAddNew?: (type: SupportedEntry) => void; text: string;
} }
export default function EmptyTableBody({ handleAddNew }: EmptyTableBodyProps) { export default function EmptyTableBody({ text }: EmptyTableBodyProps) {
const { getLocalizedString } = useTranslation();
const text = getLocalizedString('common.no_data');
return ( return (
<tbody className={style.emptyContainer}> <tbody className={style.emptyContainer}>
<tr> <tr>
<td colSpan={99} className={style.emptyCell}> <td colSpan={99} className={style.emptyCell}>
<Empty injectedStyles={{ marginTop: '5vh' }} /> <EmptyImage className={style.empty} />
<span className={style.text}>{text}</span> {text && <span className={style.text}>{text}</span>}
{handleAddNew && (
<div className={style.inline}>
<Button onClick={() => handleAddNew(SupportedEntry.Event)} variant='primary' size='large'>
<IoAdd />
Create Event
</Button>
</div>
)}
</td> </td>
</tr> </tr>
</tbody> </tbody>
@@ -12,7 +12,6 @@ import {
renameRundown, renameRundown,
} from '../api/rundown'; } from '../api/rundown';
//TODO: make suspends so we don't have to deal with no value all over
/** /**
* Project rundowns * Project rundowns
*/ */
@@ -4,7 +4,7 @@ import { useEffect, useMemo } from 'react';
import { queryRefetchIntervalSlow } from '../../ontimeConfig'; import { queryRefetchIntervalSlow } from '../../ontimeConfig';
import { CURRENT_RUNDOWN_QUERY_KEY, getRundownQueryKey } from '../api/constants'; import { CURRENT_RUNDOWN_QUERY_KEY, getRundownQueryKey } from '../api/constants';
import { fetchCurrentRundown, fetchRundown } from '../api/rundown'; import { fetchCurrentRundown } from '../api/rundown';
import { useSelectedEventId } from '../hooks/useSocket'; import { useSelectedEventId } from '../hooks/useSocket';
import { ExtendedEntry, getFlatRundownMetadata, getRundownMetadata } from '../utils/rundownMetadata'; import { ExtendedEntry, getFlatRundownMetadata, getRundownMetadata } from '../utils/rundownMetadata';
import { useProjectRundowns } from './useProjectRundowns'; import { useProjectRundowns } from './useProjectRundowns';
@@ -20,11 +20,7 @@ const cachedRundownPlaceholder: Rundown = {
}; };
/** /**
* Normalised rundown data for the currently loaded rundown. * Normalised rundown data
*
* Bootstraps via the `/current` alias so the first paint is a single round-trip,
* independent of the project rundown list. Once the loaded id is known, the
* query key swaps to the id-keyed cache that is shared with `useRundownById`.
*/ */
export default function useRundown() { export default function useRundown() {
const queryClient = useQueryClient(); const queryClient = useQueryClient();
@@ -38,7 +34,7 @@ export default function useRundown() {
refetchInterval: queryRefetchIntervalSlow, refetchInterval: queryRefetchIntervalSlow,
}); });
// Seed the id-keyed cache when fetching via the bootstrap alias // Seed the ID-based cache when fetching via the 'current' alias (bootstrap)
useEffect(() => { useEffect(() => {
if (!data || loadedRundownId) return; if (!data || loadedRundownId) return;
queryClient.setQueryData(getRundownQueryKey(data.id), data); queryClient.setQueryData(getRundownQueryKey(data.id), data);
@@ -119,21 +115,3 @@ export function useRundownAuxData() {
}, [data]); }, [data]);
return { data: filteredData, status }; return { data: filteredData, status };
} }
/**
* Provides access to a specific rundown by ID.
* When rundownId is null/undefined the query is disabled and returns the placeholder.
*/
export function useRundownById(rundownId: string | null | undefined) {
const enabled = Boolean(rundownId);
const { data, status, isError, refetch, isFetching } = useQuery<Rundown>({
queryKey: getRundownQueryKey(rundownId ?? ''),
queryFn: ({ signal }) => fetchRundown(rundownId!, { signal }),
enabled,
placeholderData: (previousData, _previousQuery) => previousData,
refetchInterval: queryRefetchIntervalSlow,
});
return { data: data ?? cachedRundownPlaceholder, status, isError, refetch, isFetching };
}
@@ -1,54 +0,0 @@
import { EntryId, Rundown } from 'ontime-types';
import { useMemo } from 'react';
import { useSelectedEventId } from '../hooks/useSocket';
import { getFlatRundownMetadata, type ExtendedEntry } from '../utils/rundownMetadata';
import { useProjectRundowns } from './useProjectRundowns';
import { useRundownById } from './useRundown';
export type RundownSource = {
rundownId: string | null;
rundown: Rundown;
flatRundown: ExtendedEntry[];
status: string;
selectedEventId: EntryId | null;
};
/**
* Explicitly scoped rundown data for views that may operate on a non-loaded rundown.
*/
export function useScopedRundown(rundownId: string | null): RundownSource {
const { data: projectRundowns } = useProjectRundowns();
return useRundownSource(rundownId, projectRundowns.loaded || null);
}
/**
* Loaded-rundown source for views that must follow the active runtime rundown.
*/
export function useLoadedRundownSource(): RundownSource {
const { data: projectRundowns } = useProjectRundowns();
const loadedRundownId = projectRundowns.loaded || null;
return useRundownSource(loadedRundownId, loadedRundownId);
}
function useRundownSource(rundownId: string | null, loadedRundownId: string | null): RundownSource {
const isLoadedTarget = rundownId !== null && rundownId === loadedRundownId;
const runtimeSelectedEventId = useSelectedEventId();
const effectiveSelectedEventId = isLoadedTarget ? runtimeSelectedEventId : null;
const { data: rundown, status } = useRundownById(rundownId);
const flatRundown = useMemo(
() => getFlatRundownMetadata(rundown, effectiveSelectedEventId),
[effectiveSelectedEventId, rundown],
);
return useMemo(
() => ({
rundownId,
rundown,
flatRundown,
status,
selectedEventId: effectiveSelectedEventId,
}),
[effectiveSelectedEventId, flatRundown, rundown, rundownId, status],
);
}
+8 -15
View File
@@ -63,16 +63,9 @@ export type EventOptions = Partial<{
}>; }>;
/** /**
* Gather utilities for actions on entries in the loaded rundown. * Gather utilities for actions on entries
*/ */
export const useEntryActions = () => useEntryActionsForRundown(undefined); export const useEntryActions = () => {
/**
* Gather utilities for actions on entries in an explicitly selected rundown.
*/
export const useScopedEntryActions = (rundownId: string | null) => useEntryActionsForRundown(rundownId ?? '');
function useEntryActionsForRundown(scopedRundownId: string | undefined) {
const queryClient = useQueryClient(); const queryClient = useQueryClient();
const { const {
linkPrevious, linkPrevious,
@@ -85,12 +78,12 @@ function useEntryActionsForRundown(scopedRundownId: string | undefined) {
} = useEditorSettings(); } = useEditorSettings();
const resolveCurrentRundownQueryKey = useCallback(() => { const resolveCurrentRundownQueryKey = useCallback(() => {
if (scopedRundownId !== undefined) {
return getRundownQueryKey(scopedRundownId);
}
const loadedRundownId = queryClient.getQueryData<ProjectRundownsList>(PROJECT_RUNDOWNS)?.loaded; const loadedRundownId = queryClient.getQueryData<ProjectRundownsList>(PROJECT_RUNDOWNS)?.loaded;
return loadedRundownId ? getRundownQueryKey(loadedRundownId) : CURRENT_RUNDOWN_QUERY_KEY; if (loadedRundownId) {
}, [queryClient, scopedRundownId]); return getRundownQueryKey(loadedRundownId);
}
return CURRENT_RUNDOWN_QUERY_KEY;
}, [queryClient]);
/** /**
* Returns the currently loaded rundown * Returns the currently loaded rundown
@@ -1011,7 +1004,7 @@ function useEntryActionsForRundown(scopedRundownId: string | undefined) {
updateTimer, updateTimer,
], ],
); );
} };
/** /**
* Utility to optimistically delete entries from client cache * Utility to optimistically delete entries from client cache
@@ -1,6 +1,10 @@
import { useEffect, useRef } from 'react'; import { useEffect, useRef } from 'react';
export default function useScrollIntoView<T extends HTMLElement>(name: string, location?: string) { export default function useScrollIntoView<T extends HTMLElement>(
name: string,
location?: string,
onVisible?: (name: string) => void,
) {
const ref = useRef<T>(null); const ref = useRef<T>(null);
useEffect(() => { useEffect(() => {
@@ -11,5 +15,17 @@ export default function useScrollIntoView<T extends HTMLElement>(name: string, l
} }
}, [location, name]); }, [location, name]);
useEffect(() => {
if (!ref.current || !onVisible) return;
const observer = new IntersectionObserver(
([entry]) => {
if (entry.isIntersecting) onVisible(name);
},
{ threshold: 0.3, rootMargin: '0px 0px -40% 0px' },
);
observer.observe(ref.current);
return () => observer.disconnect();
}, [name, onVisible]);
return ref; return ref;
} }
@@ -40,15 +40,6 @@ describe('getRouteFromPreset()', () => {
options: {}, options: {},
}, },
]; ];
const disabledPresets: URLPreset[] = [
{
enabled: false,
alias: 'demopage',
target: OntimeView.Timer,
search: 'user=guest',
options: {},
},
];
it('checks if the current location matches an enabled preset', () => { it('checks if the current location matches an enabled preset', () => {
// we make the current location be the alias // we make the current location be the alias
@@ -56,16 +47,6 @@ describe('getRouteFromPreset()', () => {
expect(getRouteFromPreset(location, presets)).toStrictEqual('timer?user=guest&alias=demopage'); expect(getRouteFromPreset(location, presets)).toStrictEqual('timer?user=guest&alias=demopage');
}); });
it('checks if the current location matches an enabled preset target', () => {
const location = resolvePath('/timer');
expect(getRouteFromPreset(location, presets)).toStrictEqual('timer?user=guest&alias=demopage');
});
it('does not redirect disabled presets', () => {
const location = resolvePath('/demopage');
expect(getRouteFromPreset(location, disabledPresets)).toBeNull();
});
it('returns null when already on a preset path', () => { it('returns null when already on a preset path', () => {
const location = resolvePath('/preset/demopage'); const location = resolvePath('/preset/demopage');
expect(getRouteFromPreset(location, presets)).toBeNull(); expect(getRouteFromPreset(location, presets)).toBeNull();
@@ -105,11 +86,6 @@ describe('getRouteFromPreset()', () => {
const location = resolvePath('/demopage?n=1&token=123'); const location = resolvePath('/demopage?n=1&token=123');
expect(getRouteFromPreset(location, presets)).toBe('timer?user=guest&alias=demopage&n=1&token=123'); expect(getRouteFromPreset(location, presets)).toBe('timer?user=guest&alias=demopage&n=1&token=123');
}); });
it('redirects stale unwrapped params back to the saved preset params while preserving feature params', () => {
const location = resolvePath('/timer?user=admin&alias=demopage&n=1&token=123');
expect(getRouteFromPreset(location, presets)).toBe('timer?user=guest&alias=demopage&n=1&token=123');
});
}); });
describe('cuesheet presets', () => { describe('cuesheet presets', () => {
+2 -7
View File
@@ -14,8 +14,8 @@ import {
APP_SETTINGS, APP_SETTINGS,
CLIENT_LIST, CLIENT_LIST,
CSS_OVERRIDE, CSS_OVERRIDE,
CURRENT_RUNDOWN_QUERY_KEY,
CUSTOM_FIELDS, CUSTOM_FIELDS,
CURRENT_RUNDOWN_QUERY_KEY,
PROJECT_DATA, PROJECT_DATA,
REPORT, REPORT,
RUNDOWN, RUNDOWN,
@@ -213,9 +213,6 @@ export const connectSocket = () => {
case RefetchKey.Settings: case RefetchKey.Settings:
ontimeQueryClient.invalidateQueries({ queryKey: APP_SETTINGS }); ontimeQueryClient.invalidateQueries({ queryKey: APP_SETTINGS });
break; break;
case RefetchKey.ProjectRundowns:
ontimeQueryClient.invalidateQueries({ queryKey: PROJECT_RUNDOWNS });
break;
default: { default: {
target satisfies never; target satisfies never;
break; break;
@@ -245,9 +242,7 @@ export function maybeInvalidateRundownCache(revision: MaybeNumber, rundownId?: s
// skip if we dont recognise the ID the revision is lower // skip if we dont recognise the ID the revision is lower
const queryKey = getRundownQueryKey(rundownId); const queryKey = getRundownQueryKey(rundownId);
const cachedRundown = ontimeQueryClient.getQueryData<{ revision: number }>(queryKey); const cachedRundown = ontimeQueryClient.getQueryData<{ revision: number }>(queryKey);
if (revision !== null && revision === cachedRundown?.revision) {
if (revision === cachedRundown?.revision) {
// we already have the latest change
return; return;
} }
+8 -9
View File
@@ -4,7 +4,6 @@ import {
MILLIS_PER_MINUTE, MILLIS_PER_MINUTE,
MILLIS_PER_SECOND, MILLIS_PER_SECOND,
formatFromMillis, formatFromMillis,
getExpectedEnd,
getExpectedStart, getExpectedStart,
} from 'ontime-utils'; } from 'ontime-utils';
@@ -173,15 +172,13 @@ export function getExpectedTimesFromExtendedEvent(
) { ) {
if (event === null) return { expectedStart: 0, timeToStart: 0, expectedEnd: 0, plannedEnd: 0 }; if (event === null) return { expectedStart: 0, timeToStart: 0, expectedEnd: 0, plannedEnd: 0 };
const expectedStartState = {
totalGap: event.totalGap,
isLinkedToLoaded: event.isLinkedToLoaded,
...state,
};
const expectedStart = getExpectedStart( const expectedStart = getExpectedStart(
{ timeStart: event.timeStart, delay: event.delay, dayOffset: event.dayOffset }, { timeStart: event.timeStart, delay: event.delay, dayOffset: event.dayOffset },
expectedStartState, {
totalGap: event.totalGap,
isLinkedToLoaded: event.isLinkedToLoaded,
...state,
},
); );
const plannedEnd = event.timeStart + event.duration + event.delay; const plannedEnd = event.timeStart + event.duration + event.delay;
@@ -189,7 +186,9 @@ export function getExpectedTimesFromExtendedEvent(
return { return {
expectedStart, expectedStart,
timeToStart: expectedStart - state.clock, timeToStart: expectedStart - state.clock,
expectedEnd: getExpectedEnd(event, expectedStartState), expectedEnd: event.countToEnd
? Math.max(expectedStart + event.duration, plannedEnd)
: expectedStart + event.duration,
plannedEnd, plannedEnd,
}; };
} }
@@ -4,7 +4,7 @@
width: 100%; width: 100%;
padding: 1rem; padding: 1rem;
display: flex; display: flex;
gap: 0.25rem; gap: 0;
overflow: hidden; overflow: hidden;
background-color: $ui-black; background-color: $ui-black;
@@ -1,6 +1,7 @@
import { ErrorBoundary } from '@sentry/react'; import { ErrorBoundary } from '@sentry/react';
import { useKeyDown } from '../../common/hooks/useKeyDown'; import { useKeyDown } from '../../common/hooks/useKeyDown';
import { AppSettingsScrollContext, useScrollContextState } from './AppSettingsScrollContext';
import PanelContent from './panel-content/PanelContent'; import PanelContent from './panel-content/PanelContent';
import PanelList from './panel-list/PanelList'; import PanelList from './panel-list/PanelList';
import AboutPanel from './panel/about-panel/AboutPanel'; import AboutPanel from './panel/about-panel/AboutPanel';
@@ -17,13 +18,15 @@ import style from './AppSettings.module.scss';
export default function AppSettings() { export default function AppSettings() {
const { close, panel, location, setLocation } = useAppSettingsNavigation(); const { close, panel, location, setLocation } = useAppSettingsNavigation();
const scrollContext = useScrollContextState(panel);
useKeyDown(close, 'Escape'); useKeyDown(close, 'Escape');
return ( return (
<div className={style.container}> <div className={style.container}>
<ErrorBoundary> <ErrorBoundary>
<AppSettingsScrollContext.Provider value={scrollContext}>
<PanelList selectedPanel={panel} location={location} /> <PanelList selectedPanel={panel} location={location} />
<PanelContent onClose={close}> <PanelContent onClose={close} panel={panel} location={location}>
{panel === 'settings' && <SettingsPanel location={location} />} {panel === 'settings' && <SettingsPanel location={location} />}
{panel === 'project' && <ProjectPanel location={location} setLocation={setLocation} />} {panel === 'project' && <ProjectPanel location={location} setLocation={setLocation} />}
{panel === 'manage' && <ManagePanel location={location} />} {panel === 'manage' && <ManagePanel location={location} />}
@@ -33,6 +36,7 @@ export default function AppSettings() {
{panel === 'about' && <AboutPanel />} {panel === 'about' && <AboutPanel />}
{panel === 'shutdown' && <ShutdownPanel />} {panel === 'shutdown' && <ShutdownPanel />}
</PanelContent> </PanelContent>
</AppSettingsScrollContext.Provider>
</ErrorBoundary> </ErrorBoundary>
</div> </div>
); );
@@ -0,0 +1,31 @@
import { createContext, useCallback, useContext, useState } from 'react';
interface ScrollContextValue {
activeSection: string | undefined;
setActiveSection: (name: string) => void;
}
export const AppSettingsScrollContext = createContext<ScrollContextValue>({
activeSection: undefined,
setActiveSection: () => {},
});
export function useAppSettingsScroll() {
return useContext(AppSettingsScrollContext);
}
export function useScrollContextState(panel: string) {
const [activeSection, setActiveSectionRaw] = useState<string | undefined>(undefined);
const [trackedPanel, setTrackedPanel] = useState(panel);
if (panel !== trackedPanel) {
setTrackedPanel(panel);
setActiveSectionRaw(undefined);
}
const setActiveSection = useCallback((name: string) => {
setActiveSectionRaw(name);
}, []);
return { activeSection, setActiveSection };
}
@@ -0,0 +1,11 @@
let _isDirty = false;
export const markDirty = () => {
_isDirty = true;
};
export const markClean = () => {
_isDirty = false;
};
export const getIsDirty = () => _isDirty;
@@ -1,8 +1,19 @@
.corner { .stickyHeader {
position: fixed; position: sticky;
top: 6rem; top: 0;
right: 4rem; z-index: $zindex-nav;
z-index: $zindex-floating; display: flex;
align-items: center;
justify-content: space-between;
padding: 0.5rem 1rem;
background-color: $gray-1250;
border-bottom: 1px solid $white-10;
flex-shrink: 0;
}
.breadcrumb {
font-size: calc(1rem - 1px);
color: $gray-400;
} }
.contentWrapper { .contentWrapper {
@@ -12,6 +23,7 @@
flex: 1 1 auto; flex: 1 1 auto;
min-width: 0; min-width: 0;
position: relative; position: relative;
overflow: hidden;
} }
.content { .content {
@@ -2,22 +2,31 @@ import { PropsWithChildren } from 'react';
import { IoClose } from 'react-icons/io5'; import { IoClose } from 'react-icons/io5';
import Button from '../../../common/components/buttons/Button'; import Button from '../../../common/components/buttons/Button';
import { getPanelLabel } from '../useAppSettingsMenu';
import style from './PanelContent.module.scss'; import style from './PanelContent.module.scss';
interface PanelContentProps { interface PanelContentProps {
onClose: () => void; onClose: () => void;
panel: string;
location?: string;
} }
export default function PanelContent({ onClose, children }: PropsWithChildren<PanelContentProps>) { export default function PanelContent({ onClose, panel, location, children }: PropsWithChildren<PanelContentProps>) {
const { panelLabel, sectionLabel } = getPanelLabel(panel, location);
return ( return (
<div className={style.contentWrapper}> <div className={style.contentWrapper}>
<div className={style.content}>{children}</div> <div className={style.stickyHeader}>
<div className={style.corner}> <span className={style.breadcrumb}>
{panelLabel}
{sectionLabel ? <> {sectionLabel}</> : null}
</span>
<Button size='large' onClick={onClose}> <Button size='large' onClick={onClose}>
Close settings <IoClose /> Close settings <IoClose />
</Button> </Button>
</div> </div>
<div className={style.content}>{children}</div>
</div> </div>
); );
} }
@@ -12,6 +12,9 @@ ul {
display: flex; display: flex;
flex-direction: column; flex-direction: column;
overflow-y: auto; overflow-y: auto;
background-color: $gray-1250;
border-right: 1px solid $white-10;
padding: 0.5rem 0;
} }
.primary, .primary,
@@ -32,14 +35,16 @@ ul {
.primary { .primary {
font-size: 1rem; font-size: 1rem;
border-radius: 2px; border-radius: 6px;
display: flex; display: flex;
align-items: center; align-items: center;
gap: 0.5rem; gap: 0.5rem;
&.active { &.active {
color: $blue-400; color: $blue-400;
background-color: $gray-1100; border-left: 3px solid $blue-400;
padding-left: calc(1rem - 3px);
border-radius: 0 6px 6px 0;
} }
&.highlight { &.highlight {
@@ -63,5 +68,7 @@ ul {
&.active { &.active {
color: $blue-400; color: $blue-400;
border-left-color: $blue-400;
border-left-width: 2px;
} }
} }
@@ -3,6 +3,8 @@ import { Fragment } from 'react';
import Tooltip from '../../../common/components/tooltip/Tooltip'; import Tooltip from '../../../common/components/tooltip/Tooltip';
import { isKeyEnter } from '../../../common/utils/keyEvent'; import { isKeyEnter } from '../../../common/utils/keyEvent';
import { cx } from '../../../common/utils/styleUtils'; import { cx } from '../../../common/utils/styleUtils';
import { getIsDirty, markClean } from '../appSettingsDirtyState';
import { useAppSettingsScroll } from '../AppSettingsScrollContext';
import { SettingsOption, SettingsOptionId, useAppSettingsMenu } from '../useAppSettingsMenu'; import { SettingsOption, SettingsOptionId, useAppSettingsMenu } from '../useAppSettingsMenu';
import useAppSettingsNavigation from '../useAppSettingsNavigation'; import useAppSettingsNavigation from '../useAppSettingsNavigation';
@@ -42,18 +44,27 @@ interface PanelListItemProps {
location?: string; location?: string;
} }
function navigateWithGuard(navigate: (id: SettingsOptionId) => void, id: SettingsOptionId) {
if (getIsDirty()) {
if (!window.confirm('You have unsaved changes. Leave without saving?')) return;
markClean();
}
navigate(id);
}
function PanelListItem({ panel, isSelected, location }: PanelListItemProps) { function PanelListItem({ panel, isSelected, location }: PanelListItemProps) {
const { setLocation } = useAppSettingsNavigation(); const { setLocation } = useAppSettingsNavigation();
const { activeSection } = useAppSettingsScroll();
const classes = cx([style.primary, isSelected && style.active, panel.highlight && style.highlight]); const classes = cx([style.primary, isSelected && style.active, panel.highlight && style.highlight]);
return ( return (
<Fragment key={panel.id}> <Fragment key={panel.id}>
<li <li
key={panel.id} key={panel.id}
onClick={() => setLocation(panel.id as SettingsOptionId)} onClick={() => navigateWithGuard(setLocation, panel.id as SettingsOptionId)}
onKeyDown={(event) => { onKeyDown={(event) => {
if (isKeyEnter(event)) { if (isKeyEnter(event)) {
setLocation(panel.id as SettingsOptionId); navigateWithGuard(setLocation, panel.id as SettingsOptionId);
} }
}} }}
className={classes} className={classes}
@@ -64,14 +75,15 @@ function PanelListItem({ panel, isSelected, location }: PanelListItemProps) {
</li> </li>
{panel.secondary?.map((secondary, index) => { {panel.secondary?.map((secondary, index) => {
const id = secondary.id.split('__')[1]; const id = secondary.id.split('__')[1];
const secondaryClasses = cx([style.secondary, isSelected && location === id ? style.active : null]); const effectiveSection = isSelected ? (activeSection ?? location) : undefined;
const secondaryClasses = cx([style.secondary, effectiveSection === id ? style.active : null]);
return ( return (
<li <li
key={secondary.id + index} key={secondary.id + index}
onClick={() => setLocation(secondary.id as SettingsOptionId)} onClick={() => navigateWithGuard(setLocation, secondary.id as SettingsOptionId)}
onKeyDown={(event) => { onKeyDown={(event) => {
if (isKeyEnter(event)) { if (isKeyEnter(event)) {
setLocation(secondary.id as SettingsOptionId); navigateWithGuard(setLocation, secondary.id as SettingsOptionId);
} }
}} }}
className={secondaryClasses} className={secondaryClasses}
@@ -53,9 +53,10 @@ $inner-padding: 1rem;
.card { .card {
position: relative; position: relative;
padding: 2rem; padding: 2rem;
background-color: $white-3; background-color: $white-5;
border: 1px solid $gray-1100; border: 1px solid $gray-1100;
border-radius: 3px; border-radius: 8px;
box-shadow: $box-shadow-l1;
} }
.highlight { .highlight {
@@ -1,5 +1,6 @@
import useAutomationSettings from '../../../../common/hooks-query/useAutomationSettings'; import useAutomationSettings from '../../../../common/hooks-query/useAutomationSettings';
import useScrollIntoView from '../../../../common/hooks/useScrollIntoView'; import useScrollIntoView from '../../../../common/hooks/useScrollIntoView';
import { useAppSettingsScroll } from '../../AppSettingsScrollContext';
import type { PanelBaseProps } from '../../panel-list/PanelList'; import type { PanelBaseProps } from '../../panel-list/PanelList';
import * as Panel from '../../panel-utils/PanelUtils'; import * as Panel from '../../panel-utils/PanelUtils';
import AutomationSettingsForm from './AutomationSettingsForm'; import AutomationSettingsForm from './AutomationSettingsForm';
@@ -8,9 +9,10 @@ import TriggersList from './TriggersList';
export default function AutomationPanel({ location }: PanelBaseProps) { export default function AutomationPanel({ location }: PanelBaseProps) {
const { data, status } = useAutomationSettings(); const { data, status } = useAutomationSettings();
const settingsRef = useScrollIntoView<HTMLDivElement>('settings', location); const { setActiveSection } = useAppSettingsScroll();
const triggersRef = useScrollIntoView<HTMLDivElement>('triggers', location); const settingsRef = useScrollIntoView<HTMLDivElement>('settings', location, setActiveSection);
const automationsRef = useScrollIntoView<HTMLDivElement>('automations', location); const triggersRef = useScrollIntoView<HTMLDivElement>('triggers', location, setActiveSection);
const automationsRef = useScrollIntoView<HTMLDivElement>('automations', location, setActiveSection);
const isLoading = status === 'pending'; const isLoading = status === 'pending';
const automationState = isLoading ? undefined : data.enabledAutomations; const automationState = isLoading ? undefined : data.enabledAutomations;
@@ -12,6 +12,7 @@ import { preventEscape } from '../../../../common/utils/keyEvent';
import { isOnlyNumbers } from '../../../../common/utils/regex'; import { isOnlyNumbers } from '../../../../common/utils/regex';
import { isOntimeCloud } from '../../../../externals'; import { isOntimeCloud } from '../../../../externals';
import * as Panel from '../../panel-utils/PanelUtils'; import * as Panel from '../../panel-utils/PanelUtils';
import { useSettingsDirty } from '../../useSettingsDirty';
const oscApiDocsUrl = 'https://docs.getontime.no/api/protocols/osc/'; const oscApiDocsUrl = 'https://docs.getontime.no/api/protocols/osc/';
@@ -45,6 +46,7 @@ export default function AutomationSettingsForm({
keepDirtyValues: false, keepDirtyValues: false,
}, },
}); });
useSettingsDirty(isDirty);
const onSubmit = async (formData: AutomationSettingsProps) => { const onSubmit = async (formData: AutomationSettingsProps) => {
try { try {
@@ -1,5 +1,6 @@
import useScrollIntoView from '../../../../common/hooks/useScrollIntoView'; import useScrollIntoView from '../../../../common/hooks/useScrollIntoView';
import { isOntimeCloud } from '../../../../externals'; import { isOntimeCloud } from '../../../../externals';
import { useAppSettingsScroll } from '../../AppSettingsScrollContext';
import GenerateLinkFormExport from '../../../sharing/GenerateLinkFormExport'; import GenerateLinkFormExport from '../../../sharing/GenerateLinkFormExport';
import type { PanelBaseProps } from '../../panel-list/PanelList'; import type { PanelBaseProps } from '../../panel-list/PanelList';
import * as Panel from '../../panel-utils/PanelUtils'; import * as Panel from '../../panel-utils/PanelUtils';
@@ -8,9 +9,10 @@ import ReportSettings from './ReportSettings';
import URLPresets from './URLPresets'; import URLPresets from './URLPresets';
export default function FeaturePanel({ location }: PanelBaseProps) { export default function FeaturePanel({ location }: PanelBaseProps) {
const presetsRef = useScrollIntoView<HTMLDivElement>('presets', location); const { setActiveSection } = useAppSettingsScroll();
const linkRef = useScrollIntoView<HTMLDivElement>('link', location); const presetsRef = useScrollIntoView<HTMLDivElement>('presets', location, setActiveSection);
const reportRef = useScrollIntoView<HTMLDivElement>('report', location); const linkRef = useScrollIntoView<HTMLDivElement>('link', location, setActiveSection);
const reportRef = useScrollIntoView<HTMLDivElement>('report', location, setActiveSection);
return ( return (
<> <>
@@ -1,4 +1,5 @@
import useScrollIntoView from '../../../../common/hooks/useScrollIntoView'; import useScrollIntoView from '../../../../common/hooks/useScrollIntoView';
import { useAppSettingsScroll } from '../../AppSettingsScrollContext';
import type { PanelBaseProps } from '../../panel-list/PanelList'; import type { PanelBaseProps } from '../../panel-list/PanelList';
import * as Panel from '../../panel-utils/PanelUtils'; import * as Panel from '../../panel-utils/PanelUtils';
import CustomFieldSettings from './CustomFields'; import CustomFieldSettings from './CustomFields';
@@ -7,10 +8,11 @@ import RundownDefaultSettings from './RundownDefaultSettings';
import SourcesPanel from './sources-panel/SourcesPanel'; import SourcesPanel from './sources-panel/SourcesPanel';
export default function ManagePanel({ location }: PanelBaseProps) { export default function ManagePanel({ location }: PanelBaseProps) {
const defaultsRef = useScrollIntoView<HTMLDivElement>('defaults', location); const { setActiveSection } = useAppSettingsScroll();
const customRef = useScrollIntoView<HTMLDivElement>('custom', location); const defaultsRef = useScrollIntoView<HTMLDivElement>('defaults', location, setActiveSection);
const rundownsRef = useScrollIntoView<HTMLDivElement>('rundowns', location); const customRef = useScrollIntoView<HTMLDivElement>('custom', location, setActiveSection);
const sheetsRef = useScrollIntoView<HTMLDivElement>('sheets', location); const rundownsRef = useScrollIntoView<HTMLDivElement>('rundowns', location, setActiveSection);
const sheetsRef = useScrollIntoView<HTMLDivElement>('sheets', location, setActiveSection);
return ( return (
<> <>
@@ -9,7 +9,6 @@ import {
IoPencilOutline, IoPencilOutline,
IoTrash, IoTrash,
} from 'react-icons/io5'; } from 'react-icons/io5';
import { TbGhost3 } from 'react-icons/tb';
import { downloadAsExcel } from '../../../../common/api/excel'; import { downloadAsExcel } from '../../../../common/api/excel';
import { maybeAxiosError } from '../../../../common/api/utils'; import { maybeAxiosError } from '../../../../common/api/utils';
@@ -20,7 +19,6 @@ import { DropdownMenu } from '../../../../common/components/dropdown-menu/Dropdo
import Tag from '../../../../common/components/tag/Tag'; import Tag from '../../../../common/components/tag/Tag';
import { useMutateProjectRundowns, useProjectRundowns } from '../../../../common/hooks-query/useProjectRundowns'; import { useMutateProjectRundowns, useProjectRundowns } from '../../../../common/hooks-query/useProjectRundowns';
import { cx } from '../../../../common/utils/styleUtils'; import { cx } from '../../../../common/utils/styleUtils';
import { useDirectLinkToBackgroundEdit } from '../../../../views/cuesheet/useCuesheetRundownSelection';
import * as Panel from '../../panel-utils/PanelUtils'; import * as Panel from '../../panel-utils/PanelUtils';
import RundownRenameForm from './composite/RundownRenameForm'; import RundownRenameForm from './composite/RundownRenameForm';
import { ManageRundownForm } from './ManageRundownForm'; import { ManageRundownForm } from './ManageRundownForm';
@@ -99,8 +97,6 @@ export default function ManageRundowns() {
await downloadAsExcel(rundownId, title); await downloadAsExcel(rundownId, title);
}; };
const navigateToCuesheet = useDirectLinkToBackgroundEdit();
return ( return (
<> <>
<Panel.Section> <Panel.Section>
@@ -157,7 +153,7 @@ export default function ManageRundowns() {
</td> </td>
<td> <td>
<DropdownMenu <DropdownMenu
render={<IconButton variant='ghosted-white' data-testId='rundown_menu' />} render={<IconButton variant='ghosted-white' />}
items={[ items={[
{ {
type: 'item', type: 'item',
@@ -184,12 +180,6 @@ export default function ManageRundowns() {
label: 'Duplicate', label: 'Duplicate',
onClick: () => submitRundownDuplicate(id), onClick: () => submitRundownDuplicate(id),
}, },
{
type: 'item',
icon: TbGhost3,
label: 'Edit in cuesheet',
onClick: () => navigateToCuesheet(id),
},
{ type: 'divider' }, { type: 'divider' },
{ {
type: 'destructive', type: 'destructive',
@@ -5,14 +5,16 @@ import useScrollIntoView from '../../../../common/hooks/useScrollIntoView';
import { usePing } from '../../../../common/hooks/useSocket'; import { usePing } from '../../../../common/hooks/useSocket';
import { sendSocket } from '../../../../common/utils/socket'; import { sendSocket } from '../../../../common/utils/socket';
import { isDocker } from '../../../../externals'; import { isDocker } from '../../../../externals';
import { useAppSettingsScroll } from '../../AppSettingsScrollContext';
import type { PanelBaseProps } from '../../panel-list/PanelList'; import type { PanelBaseProps } from '../../panel-list/PanelList';
import * as Panel from '../../panel-utils/PanelUtils'; import * as Panel from '../../panel-utils/PanelUtils';
import ClientControlPanel from './client-control/ClientControlPanel'; import ClientControlPanel from './client-control/ClientControlPanel';
import LogExport from './NetworkLogExport'; import LogExport from './NetworkLogExport';
export default function NetworkLogPanel({ location }: PanelBaseProps) { export default function NetworkLogPanel({ location }: PanelBaseProps) {
const clientsRef = useScrollIntoView<HTMLDivElement>('clients', location); const { setActiveSection } = useAppSettingsScroll();
const logRef = useScrollIntoView<HTMLDivElement>('log', location); const clientsRef = useScrollIntoView<HTMLDivElement>('clients', location, setActiveSection);
const logRef = useScrollIntoView<HTMLDivElement>('log', location, setActiveSection);
return ( return (
<> <>
@@ -68,6 +68,7 @@ export default function ClientList() {
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
{ontimeClients.length === 0 && <Panel.TableEmpty label='No clients connected' />}
{ontimeClients.map(([key, client]) => { {ontimeClients.map(([key, client]) => {
const { identify, name, path } = client; const { identify, name, path } = client;
const isCurrent = id === key; const isCurrent = id === key;
@@ -125,6 +126,7 @@ export default function ClientList() {
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
{otherClients.length === 0 && <Panel.TableEmpty label='No other clients' />}
{otherClients.map(([key, client]) => { {otherClients.map(([key, client]) => {
const { name, type } = client; const { name, type } = client;
@@ -1,4 +1,5 @@
import useScrollIntoView from '../../../../common/hooks/useScrollIntoView'; import useScrollIntoView from '../../../../common/hooks/useScrollIntoView';
import { useAppSettingsScroll } from '../../AppSettingsScrollContext';
import type { PanelBaseProps } from '../../panel-list/PanelList'; import type { PanelBaseProps } from '../../panel-list/PanelList';
import * as Panel from '../../panel-utils/PanelUtils'; import * as Panel from '../../panel-utils/PanelUtils';
import QuickStart from '../../quick-start/QuickStart'; import QuickStart from '../../quick-start/QuickStart';
@@ -10,7 +11,8 @@ interface ProjectPanelProps extends PanelBaseProps {
} }
export default function ProjectPanel({ location, setLocation }: ProjectPanelProps) { export default function ProjectPanel({ location, setLocation }: ProjectPanelProps) {
const manageProjectsRef = useScrollIntoView<HTMLDivElement>('list', location); const { setActiveSection } = useAppSettingsScroll();
const manageProjectsRef = useScrollIntoView<HTMLDivElement>('list', location, setActiveSection);
const handleQuickClose = () => { const handleQuickClose = () => {
setLocation('project'); setLocation('project');
@@ -11,6 +11,7 @@ import Select from '../../../../common/components/select/Select';
import useSettings from '../../../../common/hooks-query/useSettings'; import useSettings from '../../../../common/hooks-query/useSettings';
import { preventEscape } from '../../../../common/utils/keyEvent'; import { preventEscape } from '../../../../common/utils/keyEvent';
import * as Panel from '../../panel-utils/PanelUtils'; import * as Panel from '../../panel-utils/PanelUtils';
import { useSettingsDirty } from '../../useSettingsDirty';
import GeneralPinInput from './composite/GeneralPinInput'; import GeneralPinInput from './composite/GeneralPinInput';
const TranslationModal = lazy(() => import('./composite/CustomTranslationModal')); const TranslationModal = lazy(() => import('./composite/CustomTranslationModal'));
@@ -32,6 +33,7 @@ export default function GeneralSettings() {
keepDirtyValues: true, keepDirtyValues: true,
}, },
}); });
useSettingsDirty(isDirty);
const [isOpen, handler] = useDisclosure(); const [isOpen, handler] = useDisclosure();
@@ -14,6 +14,7 @@ import { preventEscape } from '../../../../common/utils/keyEvent';
import { validateLogo } from '../../../../common/utils/uploadUtils'; import { validateLogo } from '../../../../common/utils/uploadUtils';
import { documentationUrl } from '../../../../externals'; import { documentationUrl } from '../../../../externals';
import * as Panel from '../../panel-utils/PanelUtils'; import * as Panel from '../../panel-utils/PanelUtils';
import { useSettingsDirty } from '../../useSettingsDirty';
import style from './SettingsPanel.module.scss'; import style from './SettingsPanel.module.scss';
@@ -38,6 +39,7 @@ export default function ProjectData() {
}, },
mode: 'onChange', mode: 'onChange',
}); });
useSettingsDirty(isDirty);
const { fields, append, remove } = useFieldArray({ const { fields, append, remove } = useFieldArray({
control, control,
@@ -9,6 +9,7 @@ import useServerPort from '../../../../common/hooks-query/useServerPort';
import { preventEscape } from '../../../../common/utils/keyEvent'; import { preventEscape } from '../../../../common/utils/keyEvent';
import { isOnlyNumbers } from '../../../../common/utils/regex'; import { isOnlyNumbers } from '../../../../common/utils/regex';
import * as Panel from '../../panel-utils/PanelUtils'; import * as Panel from '../../panel-utils/PanelUtils';
import { useSettingsDirty } from '../../useSettingsDirty';
interface ServerPortForm { interface ServerPortForm {
serverPort: number; serverPort: number;
@@ -27,6 +28,7 @@ export default function ServerPortSettings() {
mode: 'onChange', mode: 'onChange',
defaultValues: { serverPort: 4001 }, defaultValues: { serverPort: 4001 },
}); });
useSettingsDirty(isDirty);
useEffect(() => { useEffect(() => {
reset({ serverPort: data.port }); reset({ serverPort: data.port });
@@ -1,5 +1,6 @@
import useScrollIntoView from '../../../../common/hooks/useScrollIntoView'; import useScrollIntoView from '../../../../common/hooks/useScrollIntoView';
import { isDocker } from '../../../../externals'; import { isDocker } from '../../../../externals';
import { useAppSettingsScroll } from '../../AppSettingsScrollContext';
import type { PanelBaseProps } from '../../panel-list/PanelList'; import type { PanelBaseProps } from '../../panel-list/PanelList';
import * as Panel from '../../panel-utils/PanelUtils'; import * as Panel from '../../panel-utils/PanelUtils';
import CustomViews from '../manage-panel/CustomViews'; import CustomViews from '../manage-panel/CustomViews';
@@ -9,11 +10,12 @@ import ServerPortSettings from './ServerPortSettings';
import ViewSettings from './ViewSettings'; import ViewSettings from './ViewSettings';
export default function SettingsPanel({ location }: PanelBaseProps) { export default function SettingsPanel({ location }: PanelBaseProps) {
const dataRef = useScrollIntoView<HTMLDivElement>('data', location); const { setActiveSection } = useAppSettingsScroll();
const generalRef = useScrollIntoView<HTMLDivElement>('general', location); const dataRef = useScrollIntoView<HTMLDivElement>('data', location, setActiveSection);
const viewRef = useScrollIntoView<HTMLDivElement>('view', location); const generalRef = useScrollIntoView<HTMLDivElement>('general', location, setActiveSection);
const customViewsRef = useScrollIntoView<HTMLDivElement>('custom-views', location); const viewRef = useScrollIntoView<HTMLDivElement>('view', location, setActiveSection);
const portRef = useScrollIntoView<HTMLDivElement>('port', location); const customViewsRef = useScrollIntoView<HTMLDivElement>('custom-views', location, setActiveSection);
const portRef = useScrollIntoView<HTMLDivElement>('port', location, setActiveSection);
return ( return (
<> <>
@@ -13,6 +13,7 @@ import Tag from '../../../../common/components/tag/Tag';
import useViewSettings from '../../../../common/hooks-query/useViewSettings'; import useViewSettings from '../../../../common/hooks-query/useViewSettings';
import { preventEscape } from '../../../../common/utils/keyEvent'; import { preventEscape } from '../../../../common/utils/keyEvent';
import * as Panel from '../../panel-utils/PanelUtils'; import * as Panel from '../../panel-utils/PanelUtils';
import { useSettingsDirty } from '../../useSettingsDirty';
import CodeEditorModal from './composite/StyleEditorModal'; import CodeEditorModal from './composite/StyleEditorModal';
const cssOverrideDocsUrl = 'https://docs.getontime.no/features/custom-styling/'; const cssOverrideDocsUrl = 'https://docs.getontime.no/features/custom-styling/';
@@ -35,6 +36,7 @@ export default function ViewSettings() {
keepDirtyValues: true, keepDirtyValues: true,
}, },
}); });
useSettingsDirty(isDirty);
// update form if we get new data from server // update form if we get new data from server
useEffect(() => { useEffect(() => {
@@ -86,6 +86,15 @@ const staticOptions = [
}, },
] as const; ] as const;
export function getPanelLabel(panel: string, location?: string): { panelLabel: string; sectionLabel?: string } {
const panelOption = staticOptions.find((o) => o.id === panel);
if (!panelOption) return { panelLabel: panel };
const panelLabel = panelOption.label;
if (!location || !('secondary' in panelOption)) return { panelLabel };
const match = panelOption.secondary.find((s) => s.id.split('__')[1] === location);
return { panelLabel, sectionLabel: match?.label };
}
// a child of navigation or a child of secondary navigation // a child of navigation or a child of secondary navigation
export type SettingsOptionId = export type SettingsOptionId =
| (typeof staticOptions)[number]['id'] | (typeof staticOptions)[number]['id']
@@ -0,0 +1,14 @@
import { useEffect } from 'react';
import { markClean, markDirty } from './appSettingsDirtyState';
export function useSettingsDirty(isDirty: boolean) {
useEffect(() => {
if (isDirty) {
markDirty();
} else {
markClean();
}
return () => markClean();
}, [isDirty]);
}
@@ -6,7 +6,6 @@ import ErrorBoundary from '../../common/components/error-boundary/ErrorBoundary'
import ViewNavigationMenu from '../../common/components/navigation-menu/ViewNavigationMenu'; import ViewNavigationMenu from '../../common/components/navigation-menu/ViewNavigationMenu';
import ProtectRoute from '../../common/components/protect-route/ProtectRoute'; import ProtectRoute from '../../common/components/protect-route/ProtectRoute';
import { EntryActionsProvider } from '../../common/context/EntryActionsContext'; import { EntryActionsProvider } from '../../common/context/EntryActionsContext';
import { useLoadedRundownSource } from '../../common/hooks-query/useScopedRundown';
import { useEntryActions } from '../../common/hooks/useEntryAction'; import { useEntryActions } from '../../common/hooks/useEntryAction';
import { useIsSmallDevice } from '../../common/hooks/useIsSmallDevice'; import { useIsSmallDevice } from '../../common/hooks/useIsSmallDevice';
import { handleLinks } from '../../common/utils/linkUtils'; import { handleLinks } from '../../common/utils/linkUtils';
@@ -105,8 +104,6 @@ interface RundownRootProps {
} }
function RundownRoot({ isSmallDevice, isExtracted, viewMode, setViewMode }: RundownRootProps) { function RundownRoot({ isSmallDevice, isExtracted, viewMode, setViewMode }: RundownRootProps) {
const source = useLoadedRundownSource();
return ( return (
<div className={style.rundownRoot}> <div className={style.rundownRoot}>
{isSmallDevice ? ( {isSmallDevice ? (
@@ -115,7 +112,7 @@ function RundownRoot({ isSmallDevice, isExtracted, viewMode, setViewMode }: Rund
<RundownHeader isExtracted={isExtracted} viewMode={viewMode} setViewMode={setViewMode} /> <RundownHeader isExtracted={isExtracted} viewMode={viewMode} setViewMode={setViewMode} />
)} )}
{viewMode === RundownViewMode.List ? <RundownList /> : <RundownTable />} {viewMode === RundownViewMode.List ? <RundownList /> : <RundownTable />}
{viewMode === RundownViewMode.Table && <EntryEditModal rundown={source.rundown} />} {viewMode === RundownViewMode.Table && <EntryEditModal />}
<RenumberCuesDialog /> <RenumberCuesDialog />
</div> </div>
); );
@@ -1,6 +1,7 @@
import { OntimeEntry, Rundown, isOntimeEvent, isOntimeGroup, isOntimeMilestone } from 'ontime-types'; import { OntimeEntry, isOntimeEvent, isOntimeGroup, isOntimeMilestone } from 'ontime-types';
import { useMemo } from 'react'; import { useMemo } from 'react';
import useRundown from '../../../common/hooks-query/useRundown';
import EventEditor from './EventEditor'; import EventEditor from './EventEditor';
import GroupEditor from './GroupEditor'; import GroupEditor from './GroupEditor';
import MilestoneEditor from './MilestoneEditor'; import MilestoneEditor from './MilestoneEditor';
@@ -9,18 +10,19 @@ import style from './EntryEditor.module.scss';
interface CuesheetEntryEditorProps { interface CuesheetEntryEditorProps {
entryId: string; entryId: string;
rundown: Rundown;
} }
export default function CuesheetEntryEditor({ entryId, rundown }: CuesheetEntryEditorProps) { export default function CuesheetEntryEditor({ entryId }: CuesheetEntryEditorProps) {
const { data } = useRundown();
const entry = useMemo<OntimeEntry | null>(() => { const entry = useMemo<OntimeEntry | null>(() => {
if (rundown.order.length === 0) { if (data.order.length === 0) {
return null; return null;
} }
const event = rundown.entries[entryId]; const event = data.entries[entryId];
return event ?? null; return event ?? null;
}, [entryId, rundown.entries, rundown.order.length]); }, [entryId, data.order, data.entries]);
if (isOntimeEvent(entry)) { if (isOntimeEvent(entry)) {
return ( return (
@@ -0,0 +1,39 @@
import { Toolbar } from '@base-ui/react/toolbar';
import type { Column } from '@tanstack/react-table';
import type { ExtendedEntry } from '../../../common/utils/rundownMetadata';
import {
ColumnSettings,
ViewSettings,
} from '../../../views/cuesheet/cuesheet-table/cuesheet-table-settings/CuesheetTableSettings';
import { usePersistedRundownOptions } from '../rundown.options';
import style from '../../../views/cuesheet/cuesheet-table/cuesheet-table-settings/CuesheetTableSettings.module.scss';
interface EditorTableSettingsProps {
columns: Column<ExtendedEntry, unknown>[];
handleResetResizing: () => void;
handleResetReordering: () => void;
handleClearToggles: () => void;
}
export default function EditorTableSettings({
columns,
handleResetResizing,
handleResetReordering,
handleClearToggles,
}: EditorTableSettingsProps) {
const options = usePersistedRundownOptions();
return (
<Toolbar.Root className={style.tableSettings}>
<ViewSettings optionsStore={options} />
<ColumnSettings
columns={columns}
handleResetResizing={handleResetResizing}
handleResetReordering={handleResetReordering}
handleClearToggles={handleClearToggles}
/>
</Toolbar.Root>
);
}
@@ -1,10 +1,7 @@
import { memo, useEffect, useMemo } from 'react'; import { memo, useEffect, useMemo } from 'react';
import EmptyPage from '../../../common/components/state/EmptyPage'; import EmptyPage from '../../../common/components/state/EmptyPage';
import { EntryActionsProvider } from '../../../common/context/EntryActionsContext';
import useCustomFields from '../../../common/hooks-query/useCustomFields'; import useCustomFields from '../../../common/hooks-query/useCustomFields';
import { useLoadedRundownSource } from '../../../common/hooks-query/useScopedRundown';
import { useEntryActions } from '../../../common/hooks/useEntryAction';
import CuesheetDnd from '../../../views/cuesheet/cuesheet-dnd/CuesheetDnd'; import CuesheetDnd from '../../../views/cuesheet/cuesheet-dnd/CuesheetDnd';
import CuesheetTable from '../../../views/cuesheet/cuesheet-table/CuesheetTable'; import CuesheetTable from '../../../views/cuesheet/cuesheet-table/CuesheetTable';
import { useCuesheetPermissions } from '../../../views/cuesheet/useTablePermissions'; import { useCuesheetPermissions } from '../../../views/cuesheet/useTablePermissions';
@@ -16,8 +13,6 @@ function RundownTable() {
const { data: customFields, status: customFieldStatus } = useCustomFields(); const { data: customFields, status: customFieldStatus } = useCustomFields();
const setPermissions = useCuesheetPermissions((state) => state.setPermissions); const setPermissions = useCuesheetPermissions((state) => state.setPermissions);
const { editorMode } = useEditorFollowMode(); const { editorMode } = useEditorFollowMode();
const source = useLoadedRundownSource();
const actions = useEntryActions();
// Editor always has full permissions // Editor always has full permissions
useEffect(() => { useEffect(() => {
@@ -35,14 +30,12 @@ function RundownTable() {
const isLoading = !customFields || customFieldStatus === 'pending'; const isLoading = !customFields || customFieldStatus === 'pending';
return ( return (
<EntryActionsProvider actions={actions}> <CuesheetDnd columns={columns} tableRoot='editor'>
<CuesheetDnd columns={columns} tableRoot='editor'> {isLoading ? (
{isLoading ? ( <EmptyPage text='Loading...' />
<EmptyPage text='Loading...' /> ) : (
) : ( <CuesheetTable columns={columns} cuesheetMode={editorMode} tableRoot='editor' />
<CuesheetTable columns={columns} source={source} cuesheetMode={editorMode} tableRoot='editor' /> )}
)} </CuesheetDnd>
</CuesheetDnd>
</EntryActionsProvider>
); );
} }
@@ -2,7 +2,7 @@ import { EntryId, MaybeNumber, ProjectRundownsList, Rundown, isOntimeEvent } fro
import { MouseEvent } from 'react'; import { MouseEvent } from 'react';
import { create } from 'zustand'; import { create } from 'zustand';
import { PROJECT_RUNDOWNS, getRundownQueryKey } from '../../common/api/constants'; import { CURRENT_RUNDOWN_QUERY_KEY, PROJECT_RUNDOWNS, getRundownQueryKey } from '../../common/api/constants';
import { ontimeQueryClient } from '../../common/queryClient'; import { ontimeQueryClient } from '../../common/queryClient';
import { isMacOS } from '../../common/utils/deviceUtils'; import { isMacOS } from '../../common/utils/deviceUtils';
@@ -137,9 +137,12 @@ export const useEventSelection = create<EventSelectionStore>()((set, get) => ({
})); }));
function getLoadedRundownData() { function getLoadedRundownData() {
const rundownId = ontimeQueryClient.getQueryData<ProjectRundownsList>(PROJECT_RUNDOWNS)?.loaded; const loadedRundownId = ontimeQueryClient.getQueryData<ProjectRundownsList>(PROJECT_RUNDOWNS)?.loaded;
if (!rundownId) return undefined; if (loadedRundownId) {
return ontimeQueryClient.getQueryData<Rundown>(getRundownQueryKey(rundownId)); return ontimeQueryClient.getQueryData<Rundown>(getRundownQueryKey(loadedRundownId));
}
return ontimeQueryClient.getQueryData<Rundown>(CURRENT_RUNDOWN_QUERY_KEY);
} }
export function getSelectionMode(event: MouseEvent): SelectionMode { export function getSelectionMode(event: MouseEvent): SelectionMode {
+1 -1
View File
@@ -82,5 +82,5 @@ export const initializeSentry = () => {
}, },
}); });
return Sentry.withSentryReactRouterV7Routing(Routes); return Sentry.withSentryReactRouterV6Routing(Routes);
}; };
@@ -14,7 +14,3 @@
'table'; 'table';
color: $ui-white; color: $ui-white;
} }
.rundownSelect {
min-width: min(20rem, calc(100vw - 6rem));
}
@@ -4,34 +4,28 @@ import { IoApps } from 'react-icons/io5';
import IconButton from '../../common/components/buttons/IconButton'; import IconButton from '../../common/components/buttons/IconButton';
import NavigationMenu from '../../common/components/navigation-menu/NavigationMenu'; import NavigationMenu from '../../common/components/navigation-menu/NavigationMenu';
import { EntryActionsProvider } from '../../common/context/EntryActionsContext'; import { EntryActionsProvider } from '../../common/context/EntryActionsContext';
import { useScopedRundown } from '../../common/hooks-query/useScopedRundown'; import { useEntryActions } from '../../common/hooks/useEntryAction';
import { useScopedEntryActions } from '../../common/hooks/useEntryAction';
import { useWindowTitle } from '../../common/hooks/useWindowTitle'; import { useWindowTitle } from '../../common/hooks/useWindowTitle';
import { getIsNavigationLocked } from '../../externals'; import { getIsNavigationLocked } from '../../externals';
import CuesheetOverview from '../../features/overview/CuesheetOverview'; import CuesheetOverview from '../../features/overview/CuesheetOverview';
import EntryEditModal from './cuesheet-edit-modal/EntryEditModal'; import EntryEditModal from './cuesheet-edit-modal/EntryEditModal';
import CuesheetProgress from './cuesheet-progress/CuesheetProgress'; import CuesheetProgress from './cuesheet-progress/CuesheetProgress';
import CuesheetTableWrapper from './CuesheetTableWrapper'; import CuesheetTableWrapper from './CuesheetTableWrapper';
import { FOLLOW_LOADED_RUNDOWN_ID, useCuesheetRundownSelection } from './useCuesheetRundownSelection';
import styles from './CuesheetPage.module.scss'; import styles from './CuesheetPage.module.scss';
export default function CuesheetPage() { export default function CuesheetPage() {
'use memo';
const [isMenuOpen, menuHandler] = useDisclosure(); const [isMenuOpen, menuHandler] = useDisclosure();
const { selectedRundownId, loadedRundownId, setSelectedRundownId, projectRundowns } = useCuesheetRundownSelection(); const entryActions = useEntryActions();
const source = useScopedRundown(selectedRundownId === FOLLOW_LOADED_RUNDOWN_ID ? loadedRundownId : selectedRundownId);
const actions = useScopedEntryActions(source.rundownId);
useWindowTitle('Cuesheet'); useWindowTitle('Cuesheet');
const isLocked = getIsNavigationLocked(); const isLocked = getIsNavigationLocked();
return ( return (
<EntryActionsProvider actions={actions}> <EntryActionsProvider actions={entryActions}>
<NavigationMenu isOpen={isMenuOpen} onClose={menuHandler.close} /> <NavigationMenu isOpen={isMenuOpen} onClose={menuHandler.close} />
<EntryEditModal rundown={source.rundown} /> <EntryEditModal />
<div className={styles.tableWrapper} data-testid='cuesheet'> <div className={styles.tableWrapper} data-testid='cuesheet'>
<CuesheetOverview> <CuesheetOverview>
{!isLocked && ( {!isLocked && (
@@ -41,13 +35,7 @@ export default function CuesheetPage() {
)} )}
</CuesheetOverview> </CuesheetOverview>
<CuesheetProgress /> <CuesheetProgress />
<CuesheetTableWrapper <CuesheetTableWrapper />
source={source}
selectedRundownId={selectedRundownId}
loadedRundownId={loadedRundownId}
setSelectedRundownId={setSelectedRundownId}
projectRundowns={projectRundowns}
/>
</div> </div>
</EntryActionsProvider> </EntryActionsProvider>
); );
@@ -1,40 +1,18 @@
import { MaybeString, ProjectRundown } from 'ontime-types';
import { memo, use, useMemo } from 'react'; import { memo, use, useMemo } from 'react';
import Select from '../../common/components/select/Select';
import EmptyPage from '../../common/components/state/EmptyPage'; import EmptyPage from '../../common/components/state/EmptyPage';
import { PresetContext } from '../../common/context/PresetContext'; import { PresetContext } from '../../common/context/PresetContext';
import useCustomFields from '../../common/hooks-query/useCustomFields'; import useCustomFields from '../../common/hooks-query/useCustomFields';
import type { RundownSource } from '../../common/hooks-query/useScopedRundown';
import { AppMode } from '../../ontimeConfig';
import CuesheetDnd from './cuesheet-dnd/CuesheetDnd'; import CuesheetDnd from './cuesheet-dnd/CuesheetDnd';
import { makeCuesheetColumns } from './cuesheet-table/cuesheet-table-elements/cuesheetColsFactory'; import { makeCuesheetColumns } from './cuesheet-table/cuesheet-table-elements/cuesheetColsFactory';
import CuesheetTable from './cuesheet-table/CuesheetTable'; import CuesheetTable from './cuesheet-table/CuesheetTable';
import { useApplyCuesheetPolicy } from './useApplyCuesheetPolicy'; import { useApplyCuesheetPolicy } from './useApplyCuesheetPolicy';
import { FOLLOW_LOADED_RUNDOWN_ID } from './useCuesheetRundownSelection';
import styles from './CuesheetPage.module.scss';
interface CuesheetTableWrapperProps {
source: RundownSource;
selectedRundownId: MaybeString;
loadedRundownId: string;
setSelectedRundownId: (rundownId: string) => void;
projectRundowns: ProjectRundown[];
}
export default memo(CuesheetTableWrapper); export default memo(CuesheetTableWrapper);
function CuesheetTableWrapper({ function CuesheetTableWrapper() {
source,
selectedRundownId,
setSelectedRundownId,
loadedRundownId,
projectRundowns,
}: CuesheetTableWrapperProps) {
const preset = use(PresetContext);
const isCurrentRundown = source.rundownId !== null && source.rundownId === loadedRundownId;
const { cuesheetMode, setCuesheetMode } = useApplyCuesheetPolicy(preset, { canRunMode: isCurrentRundown });
const { data: customFields, status: customFieldStatus } = useCustomFields(); const { data: customFields, status: customFieldStatus } = useCustomFields();
const preset = use(PresetContext);
const { cuesheetMode, setCuesheetMode } = useApplyCuesheetPolicy(preset);
const columns = useMemo( const columns = useMemo(
() => makeCuesheetColumns(customFields, cuesheetMode, preset), () => makeCuesheetColumns(customFields, cuesheetMode, preset),
@@ -50,66 +28,11 @@ function CuesheetTableWrapper({
) : ( ) : (
<CuesheetTable <CuesheetTable
columns={columns} columns={columns}
source={source}
cuesheetMode={cuesheetMode} cuesheetMode={cuesheetMode}
tableRoot='cuesheet' tableRoot='cuesheet'
setCuesheetMode={setCuesheetMode} setCuesheetMode={setCuesheetMode}
isCurrentRundown={isCurrentRundown}
insertElement={
<>
<RundownSelect
cuesheetMode={cuesheetMode}
selectedRundownId={selectedRundownId}
loadedRundownId={loadedRundownId}
setSelectedRundownId={setSelectedRundownId}
projectRundowns={projectRundowns}
/>
</>
}
/> />
)} )}
</CuesheetDnd> </CuesheetDnd>
); );
} }
interface RundownSelectProps {
cuesheetMode: AppMode;
selectedRundownId: MaybeString;
loadedRundownId: string;
setSelectedRundownId: (rundownId: string) => void;
projectRundowns: ProjectRundown[];
}
function RundownSelect({
cuesheetMode,
projectRundowns,
loadedRundownId,
selectedRundownId,
setSelectedRundownId,
}: RundownSelectProps) {
'use memo';
const options = projectRundowns.map(({ id, title }) => ({
value: id,
label: loadedRundownId === id ? `${title} (loaded)` : title,
}));
options.unshift({
value: FOLLOW_LOADED_RUNDOWN_ID,
label: 'Follow loaded', // TODO: Better wording and maybe icon? and translation
});
return (
<div className={styles.rundownSelect}>
<Select
value={selectedRundownId ?? undefined}
options={options}
onValueChange={(value) => {
if (value) {
setSelectedRundownId(value);
}
}}
disabled={cuesheetMode === AppMode.Run}
fluid
/>
</div>
);
}
@@ -1,25 +0,0 @@
import { describe, expect, it } from 'vitest';
import { AppMode } from '../../../ontimeConfig';
import { getEffectiveCuesheetMode } from '../useApplyCuesheetPolicy';
describe('getEffectiveCuesheetMode()', () => {
it('honors the stored mode when the user can change mode on the current rundown', () => {
const permissions = { canChangeMode: true };
expect(getEffectiveCuesheetMode(permissions, AppMode.Edit, { canRunMode: true })).toBe(AppMode.Edit);
expect(getEffectiveCuesheetMode(permissions, AppMode.Run, { canRunMode: true })).toBe(AppMode.Run);
});
it('forces Run mode when the preset forbids mode changes', () => {
const permissions = { canChangeMode: false };
expect(getEffectiveCuesheetMode(permissions, AppMode.Edit, { canRunMode: true })).toBe(AppMode.Run);
});
it('forces Edit mode for background rundowns without changing the permission policy', () => {
const permissions = { canChangeMode: true };
expect(getEffectiveCuesheetMode(permissions, AppMode.Run, { canRunMode: false })).toBe(AppMode.Edit);
});
});
@@ -1,21 +0,0 @@
import {
FOLLOW_LOADED_RUNDOWN_ID,
getCuesheetRundownStorageKey,
resolveSelectedRundownId,
} from '../useCuesheetRundownSelection';
describe('useCuesheetRundownSelection helpers', () => {
it('builds a project-scoped storage key', () => {
expect(getCuesheetRundownStorageKey('http://localhost:4001', 'My Project')).toBe(
'cuesheet-selected-rundown:http://localhost:4001:My Project',
);
});
it('falls back to the follow loaded rundown when the stored selection is missing', () => {
expect(resolveSelectedRundownId('missing', new Set(['loaded', 'other']))).toBe(FOLLOW_LOADED_RUNDOWN_ID);
});
it('keeps the stored selection when it still exists in the current project', () => {
expect(resolveSelectedRundownId('other', new Set(['loaded', 'other']))).toBe('other');
});
});
@@ -1,16 +1,11 @@
import { Rundown } from 'ontime-types';
import { memo } from 'react'; import { memo } from 'react';
import Modal from '../../../common/components/modal/Modal'; import Modal from '../../../common/components/modal/Modal';
import CuesheetEntryEditor from '../../../features/rundown/entry-editor/CuesheetEventEditor'; import CuesheetEntryEditor from '../../../features/rundown/entry-editor/CuesheetEventEditor';
import { useEditModal } from './useEditModal'; import { useEditModal } from './useEditModal';
interface EntryEditModalProps {
rundown: Rundown;
}
export default memo(EntryEditModal); export default memo(EntryEditModal);
function EntryEditModal({ rundown }: EntryEditModalProps) { function EntryEditModal() {
const entryId = useEditModal((state) => state.selectedEntryId); const entryId = useEditModal((state) => state.selectedEntryId);
const closeModal = useEditModal((state) => state.clearSelection); const closeModal = useEditModal((state) => state.clearSelection);
@@ -24,7 +19,7 @@ function EntryEditModal({ rundown }: EntryEditModalProps) {
onClose={closeModal} onClose={closeModal}
title='Edit entry' title='Edit entry'
showCloseButton showCloseButton
bodyElements={<CuesheetEntryEditor entryId={entryId} rundown={rundown} />} bodyElements={<CuesheetEntryEditor entryId={entryId} />}
/> />
); );
} }
@@ -1,7 +1,7 @@
import { useTableNav } from '@table-nav/react'; import { useTableNav } from '@table-nav/react';
import { ColumnDef, Table, getCoreRowModel, useReactTable } from '@tanstack/react-table'; import { ColumnDef, Table, getCoreRowModel, useReactTable } from '@tanstack/react-table';
import { OntimeEntry, SupportedEntry, TimeField, isOntimeDelay, isOntimeGroup, isOntimeMilestone } from 'ontime-types'; import { OntimeEntry, TimeField, isOntimeDelay, isOntimeGroup, isOntimeMilestone } from 'ontime-types';
import { ComponentProps, ReactNode, memo, useCallback, useEffect, useMemo, useRef } from 'react'; import { ComponentProps, memo, useCallback, useEffect, useMemo, useRef } from 'react';
import { import {
ContextProp, ContextProp,
ItemProps, ItemProps,
@@ -14,20 +14,21 @@ import {
import EmptyPage from '../../../common/components/state/EmptyPage'; import EmptyPage from '../../../common/components/state/EmptyPage';
import EmptyTableBody from '../../../common/components/state/EmptyTableBody'; import EmptyTableBody from '../../../common/components/state/EmptyTableBody';
import { useEntryActionsContext } from '../../../common/context/EntryActionsContext'; import { useEntryActionsContext } from '../../../common/context/EntryActionsContext';
import type { RundownSource } from '../../../common/hooks-query/useScopedRundown'; import { useFlatRundownWithMetadata } from '../../../common/hooks-query/useRundown';
import { useSelectedEventId } from '../../../common/hooks/useSocket';
import type { ExtendedEntry } from '../../../common/utils/rundownMetadata'; import type { ExtendedEntry } from '../../../common/utils/rundownMetadata';
import EditorTableSettings from '../../../features/rundown/rundown-table/EditorTableSettings';
import { usePersistedRundownOptions } from '../../../features/rundown/rundown.options'; import { usePersistedRundownOptions } from '../../../features/rundown/rundown.options';
import { useEventSelection } from '../../../features/rundown/useEventSelection'; import { useEventSelection } from '../../../features/rundown/useEventSelection';
import { AppMode } from '../../../ontimeConfig'; import { AppMode } from '../../../ontimeConfig';
import { usePersistedCuesheetOptions } from '../cuesheet.options'; import { usePersistedCuesheetOptions } from '../cuesheet.options';
import { useCuesheetPermissions } from '../useTablePermissions';
import { CuesheetHeader, SortableCuesheetHeader } from './cuesheet-table-elements/CuesheetHeader'; import { CuesheetHeader, SortableCuesheetHeader } from './cuesheet-table-elements/CuesheetHeader';
import DelayRow from './cuesheet-table-elements/DelayRow'; import DelayRow from './cuesheet-table-elements/DelayRow';
import EventRow from './cuesheet-table-elements/EventRow'; import EventRow from './cuesheet-table-elements/EventRow';
import GroupRow from './cuesheet-table-elements/GroupRow'; import GroupRow from './cuesheet-table-elements/GroupRow';
import MilestoneRow from './cuesheet-table-elements/MilestoneRow'; import MilestoneRow from './cuesheet-table-elements/MilestoneRow';
import TableMenu from './cuesheet-table-menu/TableMenu'; import TableMenu from './cuesheet-table-menu/TableMenu';
import CuesheetTableHeaderToolbar from './cuesheet-table-settings/CuesheetTableHeaderToolbar'; import CuesheetTableSettings from './cuesheet-table-settings/CuesheetTableSettings';
import { useColumnOrder, useColumnSizes, useColumnVisibility } from './useColumnManager'; import { useColumnOrder, useColumnSizes, useColumnVisibility } from './useColumnManager';
import style from './CuesheetTable.module.scss'; import style from './CuesheetTable.module.scss';
@@ -35,41 +36,30 @@ import style from './CuesheetTable.module.scss';
type CuesheetTableBaseProps = { type CuesheetTableBaseProps = {
columns: ColumnDef<ExtendedEntry>[]; columns: ColumnDef<ExtendedEntry>[];
cuesheetMode: AppMode; cuesheetMode: AppMode;
source: RundownSource;
insertElement?: ReactNode;
}; };
type EditorCuesheetTableProps = CuesheetTableBaseProps & { type EditorCuesheetTableProps = CuesheetTableBaseProps & {
tableRoot: 'editor'; tableRoot: 'editor';
setCuesheetMode?: undefined; setCuesheetMode?: undefined;
isCurrentRundown?: undefined;
}; };
type ViewCuesheetTableProps = CuesheetTableBaseProps & { type ViewCuesheetTableProps = CuesheetTableBaseProps & {
tableRoot: 'cuesheet'; tableRoot: 'cuesheet';
setCuesheetMode: (mode: AppMode) => void; setCuesheetMode: (mode: AppMode) => void;
isCurrentRundown?: boolean;
}; };
type CuesheetTableProps = EditorCuesheetTableProps | ViewCuesheetTableProps; type CuesheetTableProps = EditorCuesheetTableProps | ViewCuesheetTableProps;
export default function CuesheetTable({ export default function CuesheetTable({ columns, cuesheetMode, tableRoot, setCuesheetMode }: CuesheetTableProps) {
columns, const { data, status } = useFlatRundownWithMetadata();
cuesheetMode, const { updateEntry, updateTimer } = useEntryActionsContext();
source,
tableRoot,
setCuesheetMode,
isCurrentRundown,
insertElement,
}: CuesheetTableProps) {
const { flatRundown, status, selectedEventId } = source;
const { updateEntry, updateTimer, addEntry } = useEntryActionsContext();
const canCreateEntries = useCuesheetPermissions((state) => state.canCreateEntries) && cuesheetMode === AppMode.Edit;
const useOptions = tableRoot === 'editor' ? usePersistedRundownOptions : usePersistedCuesheetOptions; const useOptions = tableRoot === 'editor' ? usePersistedRundownOptions : usePersistedCuesheetOptions;
const optionsStore = useOptions(); const showDelayedTimes = useOptions((state) => state.showDelayedTimes);
const { showDelayedTimes, hideTableSeconds, hideIndexColumn } = optionsStore; const hideTableSeconds = useOptions((state) => state.hideTableSeconds);
const hideIndexColumn = useOptions((state) => state.hideIndexColumn);
const selectedEventId = useSelectedEventId();
const cursor = useEventSelection((state) => state.cursor); const cursor = useEventSelection((state) => state.cursor);
const setScrollHandler = useEventSelection((state) => state.setScrollHandler); const setScrollHandler = useEventSelection((state) => state.setScrollHandler);
@@ -80,7 +70,7 @@ export default function CuesheetTable({
() => ({ () => ({
handleUpdate: (rowIndex: number, accessor: string, payload: string, isCustom = false) => { handleUpdate: (rowIndex: number, accessor: string, payload: string, isCustom = false) => {
// check if value is the same // check if value is the same
const event = flatRundown[rowIndex]; const event = data[rowIndex];
if (!event) { if (!event) {
return; return;
@@ -111,7 +101,7 @@ export default function CuesheetTable({
hideIndexColumn, hideIndexColumn,
}, },
}), }),
[cuesheetMode, flatRundown, hideIndexColumn, hideTableSeconds, showDelayedTimes, updateEntry, updateTimer], [cuesheetMode, data, hideIndexColumn, hideTableSeconds, showDelayedTimes, updateEntry, updateTimer],
); );
const { columnOrder, resetColumnOrder } = useColumnOrder(columns, tableRoot); const { columnOrder, resetColumnOrder } = useColumnOrder(columns, tableRoot);
@@ -119,7 +109,7 @@ export default function CuesheetTable({
const { columnVisibility, setColumnVisibility } = useColumnVisibility(tableRoot); const { columnVisibility, setColumnVisibility } = useColumnVisibility(tableRoot);
const table = useReactTable({ const table = useReactTable({
data: flatRundown, data,
columns, columns,
columnResizeMode: 'onChange', columnResizeMode: 'onChange',
state: { state: {
@@ -147,13 +137,13 @@ export default function CuesheetTable({
return; return;
} }
const eventIndex = flatRundown.findIndex((event) => event.id === selectedEventId); const eventIndex = data.findIndex((event) => event.id === selectedEventId);
if (eventIndex === -1) { if (eventIndex === -1) {
return; return;
} }
virtuosoRef.current.scrollToIndex({ index: eventIndex, behavior: 'auto', align: 'start', offset: -50 }); virtuosoRef.current.scrollToIndex({ index: eventIndex, behavior: 'auto', align: 'start', offset: -50 });
}, [cuesheetMode, flatRundown, selectedEventId]); }, [cuesheetMode, data, selectedEventId]);
// Provide an imperative scroll handler for explicit jumps (finder/keyboard) // Provide an imperative scroll handler for explicit jumps (finder/keyboard)
useEffect(() => { useEffect(() => {
@@ -162,7 +152,7 @@ export default function CuesheetTable({
return; return;
} }
const eventIndex = flatRundown.findIndex((event) => event.id === entryId); const eventIndex = data.findIndex((event) => event.id === entryId);
if (eventIndex === -1) { if (eventIndex === -1) {
return; return;
} }
@@ -175,7 +165,7 @@ export default function CuesheetTable({
return () => { return () => {
setScrollHandler(null); setScrollHandler(null);
}; };
}, [flatRundown, setScrollHandler]); }, [data, setScrollHandler]);
/** /**
* To improve performance on resizing, we memoise the column sizes * To improve performance on resizing, we memoise the column sizes
@@ -204,9 +194,8 @@ export default function CuesheetTable({
listeners, listeners,
rows, rows,
table, table,
handleAddNew: canCreateEntries ? (type: SupportedEntry) => addEntry({ type }) : undefined,
}), }),
[columnSizeVars, cursor, listeners, rows, table, addEntry, canCreateEntries], [columnSizeVars, cursor, listeners, rows, table],
); );
const computeItemKey = useCallback((_: number, item: ExtendedEntry) => item.id, []); const computeItemKey = useCallback((_: number, item: ExtendedEntry) => item.id, []);
@@ -228,7 +217,7 @@ export default function CuesheetTable({
}); });
}, [cuesheetMode, hideIndexColumn, table]); }, [cuesheetMode, hideIndexColumn, table]);
const isLoading = !flatRundown || status === 'pending'; const isLoading = !data || status === 'pending';
if (isLoading) { if (isLoading) {
return <EmptyPage text='Loading...' />; return <EmptyPage text='Loading...' />;
@@ -236,27 +225,26 @@ export default function CuesheetTable({
return ( return (
<> <>
<CuesheetTableHeaderToolbar {tableRoot === 'editor' ? (
columns={allLeafColumns} <EditorTableSettings
optionsStore={optionsStore} columns={allLeafColumns}
handleResetResizing={resetColumnResizing} handleResetResizing={resetColumnResizing}
handleResetReordering={resetColumnOrder} handleResetReordering={resetColumnOrder}
handleClearToggles={setAllVisible} handleClearToggles={setAllVisible}
insertElement={insertElement} />
modeControls={ ) : (
tableRoot === 'cuesheet' <CuesheetTableSettings
? { columns={allLeafColumns}
cuesheetMode, cuesheetMode={cuesheetMode}
setCuesheetMode, setCuesheetMode={setCuesheetMode}
isCurrentRundown, handleResetResizing={resetColumnResizing}
} handleResetReordering={resetColumnOrder}
: undefined handleClearToggles={setAllVisible}
} />
showShare={tableRoot === 'cuesheet'} )}
/>
<TableVirtuoso <TableVirtuoso
ref={virtuosoRef} ref={virtuosoRef}
data={flatRundown} data={data}
context={virtuosoContext} context={virtuosoContext}
style={tableRoot === 'editor' ? { paddingLeft: '1rem' } : undefined} style={tableRoot === 'editor' ? { paddingLeft: '1rem' } : undefined}
computeItemKey={computeItemKey} computeItemKey={computeItemKey}
@@ -276,13 +264,10 @@ interface CuesheetVirtuosoContext {
listeners: ReturnType<typeof useTableNav>['listeners']; listeners: ReturnType<typeof useTableNav>['listeners'];
rows: ReturnType<Table<ExtendedEntry>['getRowModel']>['rows']; rows: ReturnType<Table<ExtendedEntry>['getRowModel']>['rows'];
table: Table<ExtendedEntry>; table: Table<ExtendedEntry>;
handleAddNew?: (type: SupportedEntry) => void;
} }
const EmptyPlaceholder = memo(function EmptyPlaceholder({ const EmptyPlaceholder = memo(function EmptyPlaceholder() {
context, return <EmptyTableBody text='No data in rundown' />;
}: TableProps & ContextProp<CuesheetVirtuosoContext>) {
return <EmptyTableBody handleAddNew={context.handleAddNew} />;
}); });
const CuesheetTableElement = memo(function CuesheetTableElement({ const CuesheetTableElement = memo(function CuesheetTableElement({
@@ -49,10 +49,6 @@ function DurationInput({
setIsEditing(false); setIsEditing(false);
setTimeout(() => textRef.current?.focusParentElement()); // Immediate timeout to ensure state change takes place first setTimeout(() => textRef.current?.focusParentElement()); // Immediate timeout to ensure state change takes place first
}; };
const handleTabOut = useCallback(() => {
setIsEditing(false);
// Tab moves focus naturally; do not steal it back to parent
}, []);
const handleUpdate = useCallback( const handleUpdate = useCallback(
(newValue: string) => { (newValue: string) => {
@@ -99,10 +95,8 @@ function DurationInput({
ref={inputRef} ref={inputRef}
initialValue={timeString} initialValue={timeString}
allowSubmitSameValue={!lockedValue} // if the value is not locked, submitting will lock the value allowSubmitSameValue={!lockedValue} // if the value is not locked, submitting will lock the value
submitOnTab={false}
handleUpdate={handleUpdate} handleUpdate={handleUpdate}
handleCancelUpdate={handleFakeBlur} handleCancelUpdate={handleFakeBlur}
handleTabCancel={handleTabOut}
/> />
) : ( ) : (
<TextLikeInput <TextLikeInput
@@ -30,16 +30,15 @@ function EditableImage({ initialValue, readOnly, updateValue }: EditableImagePro
} }
}; };
if (!initialValue && readOnly) {
return null;
}
if (!initialValue) { if (!initialValue) {
return ( return (
<Input <Input
variant='ghosted' variant='ghosted'
className={style.imageInput} className={style.imageInput}
fluid fluid
readOnly={readOnly}
// we disable the field to prevent receiving focus
disabled={readOnly}
placeholder='Paste image URL' placeholder='Paste image URL'
onBlur={(event) => handleUpdate(event.currentTarget.value)} onBlur={(event) => handleUpdate(event.currentTarget.value)}
onKeyDown={(event) => { onKeyDown={(event) => {
@@ -8,24 +8,13 @@ interface SingleLineCellProps {
fieldId?: string; fieldId?: string;
fieldLabel?: string; fieldLabel?: string;
allowSubmitSameValue?: boolean; allowSubmitSameValue?: boolean;
submitOnTab?: boolean;
handleUpdate: (newValue: string) => void; handleUpdate: (newValue: string) => void;
handleCancelUpdate?: () => void; handleCancelUpdate?: () => void;
handleTabCancel?: () => void;
} }
const SingleLineCell = forwardRef( const SingleLineCell = forwardRef(
( (
{ { initialValue, fieldId, fieldLabel, allowSubmitSameValue, handleUpdate, handleCancelUpdate }: SingleLineCellProps,
initialValue,
fieldId,
fieldLabel,
allowSubmitSameValue,
submitOnTab,
handleUpdate,
handleCancelUpdate,
handleTabCancel,
}: SingleLineCellProps,
inputRef, inputRef,
) => { ) => {
const ref = useRef<HTMLInputElement | null>(null); const ref = useRef<HTMLInputElement | null>(null);
@@ -36,9 +25,7 @@ const SingleLineCell = forwardRef(
allowKeyboardNavigation: true, allowKeyboardNavigation: true,
submitOnEnter: true, // single line should submit on enter submitOnEnter: true, // single line should submit on enter
submitOnCtrlEnter: true, submitOnCtrlEnter: true,
submitOnTab,
onCancelUpdate: handleCancelUpdate, onCancelUpdate: handleCancelUpdate,
onTabCancel: handleTabCancel,
}); });
// expose a subset of the methods to the parent // expose a subset of the methods to the parent
@@ -50,10 +50,6 @@ function TimeInputDuration({
setIsEditing(false); setIsEditing(false);
setTimeout(() => textRef.current?.focusParentElement()); // Immediate timeout to ensure state change takes place first setTimeout(() => textRef.current?.focusParentElement()); // Immediate timeout to ensure state change takes place first
}; };
const handleTabOut = useCallback(() => {
setIsEditing(false);
// Tab moves focus naturally; do not steal it back to parent
}, []);
const handleUpdate = useCallback( const handleUpdate = useCallback(
(newValue: string) => { (newValue: string) => {
@@ -100,10 +96,8 @@ function TimeInputDuration({
ref={inputRef} ref={inputRef}
initialValue={timeString} initialValue={timeString}
allowSubmitSameValue={!lockedValue} // if the value is not locked, submitting will lock the value allowSubmitSameValue={!lockedValue} // if the value is not locked, submitting will lock the value
submitOnTab={false}
handleUpdate={handleUpdate} handleUpdate={handleUpdate}
handleCancelUpdate={handleFakeBlur} handleCancelUpdate={handleFakeBlur}
handleTabCancel={handleTabOut}
/> />
) : ( ) : (
<TextLikeInput <TextLikeInput
@@ -8,24 +8,6 @@
gap: 1rem; gap: 1rem;
font-size: $inner-section-text-size; font-size: $inner-section-text-size;
border-radius: 3px 3px 0 0; border-radius: 3px 3px 0 0;
transition: background-color 0.2s ease-in-out;
&[data-background-rundown='true'] {
background-color: rgba($ontime-color, 0.5);
.apart::before {
content: 'BACKGROUND EDIT';
color: $ui-white;
animation: blinker 2s ease-in-out infinite;
}
}
}
@keyframes blinker {
50% {
color: transparent;
}
} }
.sectionTitle { .sectionTitle {
@@ -61,9 +43,6 @@
.apart { .apart {
margin-left: auto; margin-left: auto;
display: flex;
align-items: center;
gap: 1rem;
} }
/** styles should match RundownHeader.module.scss */ /** styles should match RundownHeader.module.scss */
@@ -91,17 +70,12 @@
font-size: calc(1rem - 2px); font-size: calc(1rem - 2px);
font-weight: 600; font-weight: 600;
&[data-disabled] {
cursor: not-allowed;
opacity: 0.4;
}
&:focus-visible { &:focus-visible {
background: transparent; background: transparent;
outline: 1px solid $blue-500; outline: 1px solid $blue-500;
} }
&:hover:not([data-disabled]):not(:active) { &:hover:not(:disabled):not(:active) {
background: $gray-1000; background: $gray-1000;
} }
@@ -113,7 +87,7 @@
background: $blue-700; background: $blue-700;
color: $ui-white; color: $ui-white;
&:hover:not([data-disabled]):not(:active) { &:hover:not(:disabled):not(:active) {
background: $blue-600; background: $blue-600;
} }
} }
@@ -11,92 +11,78 @@ import Checkbox from '../../../../common/components/checkbox/Checkbox';
import * as Editor from '../../../../common/components/editor-utils/EditorUtils'; import * as Editor from '../../../../common/components/editor-utils/EditorUtils';
import PopoverContents from '../../../../common/components/popover/Popover'; import PopoverContents from '../../../../common/components/popover/Popover';
import type { ExtendedEntry } from '../../../../common/utils/rundownMetadata'; import type { ExtendedEntry } from '../../../../common/utils/rundownMetadata';
import { cx } from '../../../../common/utils/styleUtils';
import { AppMode } from '../../../../ontimeConfig'; import { AppMode } from '../../../../ontimeConfig';
import { CuesheetOptions, usePersistedCuesheetOptions } from '../../cuesheet.options';
import { useCuesheetPermissions } from '../../useTablePermissions'; import { useCuesheetPermissions } from '../../useTablePermissions';
import CuesheetShareModal from './CuesheetShareModal'; import CuesheetShareModal from './CuesheetShareModal';
import style from './CuesheetTableSettings.module.scss'; import style from './CuesheetTableSettings.module.scss';
type TableHeaderOptionsStore = { interface CuesheetTableSettingsProps {
hideTableSeconds: boolean; columns: Column<ExtendedEntry, unknown>[];
hideIndexColumn: boolean;
showDelayedTimes: boolean;
hideDelays: boolean;
setOption: <K extends keyof TableHeaderOptionValues>(key: K, value: TableHeaderOptionValues[K]) => void;
};
type TableHeaderOptionValues = Pick<
TableHeaderOptionsStore,
'hideTableSeconds' | 'hideIndexColumn' | 'showDelayedTimes' | 'hideDelays'
>;
type TableModeControls = {
cuesheetMode: AppMode; cuesheetMode: AppMode;
setCuesheetMode: (mode: AppMode) => void; setCuesheetMode: (mode: AppMode) => void;
isCurrentRundown?: boolean;
};
interface CuesheetTableHeaderToolbarProps {
columns: Column<ExtendedEntry, unknown>[];
optionsStore: TableHeaderOptionsStore;
handleResetResizing: () => void; handleResetResizing: () => void;
handleResetReordering: () => void; handleResetReordering: () => void;
handleClearToggles: () => void; handleClearToggles: () => void;
insertElement?: ReactNode;
modeControls?: TableModeControls;
showShare?: boolean;
} }
export default function CuesheetTableHeaderToolbar({ export interface ViewSettingsProps {
optionsStore: CuesheetOptions;
}
export interface ColumnSettingsProps {
columns: Column<ExtendedEntry, unknown>[];
handleResetResizing: () => void;
handleResetReordering: () => void;
handleClearToggles: () => void;
}
export default function CuesheetTableSettings({
columns, columns,
optionsStore, cuesheetMode,
setCuesheetMode,
handleResetResizing, handleResetResizing,
handleResetReordering, handleResetReordering,
handleClearToggles, handleClearToggles,
insertElement, }: CuesheetTableSettingsProps) {
modeControls,
showShare = false,
}: CuesheetTableHeaderToolbarProps) {
const canChangeMode = useCuesheetPermissions((state) => state.canChangeMode); const canChangeMode = useCuesheetPermissions((state) => state.canChangeMode);
const canShare = useCuesheetPermissions((state) => state.canShare); const canShare = useCuesheetPermissions((state) => state.canShare);
const options = usePersistedCuesheetOptions();
const toggleCuesheetMode = (mode: AppMode[]) => { const toggleCuesheetMode = (mode: AppMode[]) => {
// we need to stop user from deselecting a mode
const newValue = mode.at(0); const newValue = mode.at(0);
if (!newValue || !modeControls) return; if (!newValue) return;
modeControls.setCuesheetMode(newValue); setCuesheetMode(newValue);
}; };
const isBackground = !(modeControls?.isCurrentRundown ?? true);
return ( return (
<Toolbar.Root className={style.tableSettings} data-background-rundown={isBackground}> <Toolbar.Root className={style.tableSettings}>
<ViewSettings optionsStore={optionsStore} /> <ViewSettings optionsStore={options} />
<ColumnSettings <ColumnSettings
columns={columns} columns={columns}
handleResetResizing={handleResetResizing} handleResetResizing={handleResetResizing}
handleResetReordering={handleResetReordering} handleResetReordering={handleResetReordering}
handleClearToggles={handleClearToggles} handleClearToggles={handleClearToggles}
/> />
{modeControls && canChangeMode && ( {canChangeMode && (
<div className={style.apart}> <ToggleGroup
{insertElement} value={[cuesheetMode]}
<ToggleGroup onValueChange={toggleCuesheetMode}
value={[modeControls.cuesheetMode]} className={cx([style.group, style.apart])}
onValueChange={toggleCuesheetMode} >
className={style.group} <Toolbar.Button render={<Toggle />} value={AppMode.Run} className={style.radioButton}>
disabled={!modeControls.isCurrentRundown} Run
> </Toolbar.Button>
<Toolbar.Button render={<Toggle />} value={AppMode.Run} className={style.radioButton}> <Toolbar.Button render={<Toggle />} value={AppMode.Edit} className={style.radioButton}>
Run Edit
</Toolbar.Button> </Toolbar.Button>
<Toolbar.Button render={<Toggle />} value={AppMode.Edit} className={style.radioButton}> </ToggleGroup>
Edit
</Toolbar.Button>
</ToggleGroup>
</div>
)} )}
{showShare && canShare && ( {canShare && (
<> <>
<Editor.Separator orientation='vertical' /> <Editor.Separator orientation='vertical' />
<CuesheetShareModal /> <CuesheetShareModal />
@@ -106,18 +92,9 @@ export default function CuesheetTableHeaderToolbar({
); );
} }
interface ViewSettingsProps { export function ViewSettings({ optionsStore }: ViewSettingsProps) {
optionsStore: TableHeaderOptionsStore; const options = optionsStore;
}
interface ColumnSettingsProps {
columns: Column<ExtendedEntry, unknown>[];
handleResetResizing: () => void;
handleResetReordering: () => void;
handleClearToggles: () => void;
}
function ViewSettings({ optionsStore }: ViewSettingsProps) {
return ( return (
<Popover.Root> <Popover.Root>
<Popover.Trigger <Popover.Trigger
@@ -138,15 +115,15 @@ function ViewSettings({ optionsStore }: ViewSettingsProps) {
<Editor.Label className={style.sectionTitle}>Element visibility</Editor.Label> <Editor.Label className={style.sectionTitle}>Element visibility</Editor.Label>
<Editor.Label className={style.option}> <Editor.Label className={style.option}>
<Checkbox <Checkbox
defaultChecked={optionsStore.hideTableSeconds} defaultChecked={options.hideTableSeconds}
onCheckedChange={(checked) => optionsStore.setOption('hideTableSeconds', checked)} onCheckedChange={(checked) => options.setOption('hideTableSeconds', checked)}
/> />
Hide seconds in table Hide seconds in table
</Editor.Label> </Editor.Label>
<Editor.Label className={style.option}> <Editor.Label className={style.option}>
<Checkbox <Checkbox
defaultChecked={optionsStore.hideIndexColumn} defaultChecked={options.hideIndexColumn}
onCheckedChange={(checked) => optionsStore.setOption('hideIndexColumn', checked)} onCheckedChange={(checked) => options.setOption('hideIndexColumn', checked)}
/> />
Hide index column Hide index column
</Editor.Label> </Editor.Label>
@@ -156,15 +133,15 @@ function ViewSettings({ optionsStore }: ViewSettingsProps) {
<Editor.Label className={style.sectionTitle}>Table Behaviour</Editor.Label> <Editor.Label className={style.sectionTitle}>Table Behaviour</Editor.Label>
<Editor.Label className={style.option}> <Editor.Label className={style.option}>
<Checkbox <Checkbox
defaultChecked={optionsStore.showDelayedTimes} defaultChecked={options.showDelayedTimes}
onCheckedChange={(checked) => optionsStore.setOption('showDelayedTimes', checked)} onCheckedChange={(checked) => options.setOption('showDelayedTimes', checked)}
/> />
Show delayed times Show delayed times
</Editor.Label> </Editor.Label>
<Editor.Label className={style.option}> <Editor.Label className={style.option}>
<Checkbox <Checkbox
defaultChecked={optionsStore.hideDelays} defaultChecked={options.hideDelays}
onCheckedChange={(checked) => optionsStore.setOption('hideDelays', checked)} onCheckedChange={(checked) => options.setOption('hideDelays', checked)}
/> />
Hide delay entries Hide delay entries
</Editor.Label> </Editor.Label>
@@ -174,7 +151,7 @@ function ViewSettings({ optionsStore }: ViewSettingsProps) {
); );
} }
function ColumnSettings({ export function ColumnSettings({
columns, columns,
handleResetResizing, handleResetResizing,
handleResetReordering, handleResetReordering,
@@ -200,7 +177,6 @@ function ColumnSettings({
{columns.map((column) => { {columns.map((column) => {
const columnHeader = column.columnDef.header; const columnHeader = column.columnDef.header;
const visible = column.getIsVisible(); const visible = column.getIsVisible();
return ( return (
<Editor.Label key={`${column.id}-${visible}`} className={style.option}> <Editor.Label key={`${column.id}-${visible}`} className={style.option}>
<Checkbox defaultChecked={visible} onCheckedChange={column.toggleVisibility} /> <Checkbox defaultChecked={visible} onCheckedChange={column.toggleVisibility} />
@@ -5,33 +5,12 @@ import { useCallback, useEffect, useMemo } from 'react';
import { sessionScope } from '../../externals'; import { sessionScope } from '../../externals';
import { AppMode, sessionKeys } from '../../ontimeConfig'; import { AppMode, sessionKeys } from '../../ontimeConfig';
import { getCuesheetPermissionsPolicy } from './cuesheet.policies'; import { getCuesheetPermissionsPolicy } from './cuesheet.policies';
import type { CuesheetPermissions } from './useTablePermissions';
import { useCuesheetPermissions } from './useTablePermissions'; import { useCuesheetPermissions } from './useTablePermissions';
type CuesheetPolicyOptions = {
// Run mode is only meaningful for the loaded rundown — background rundowns force Edit.
canRunMode: boolean;
};
export function getEffectiveCuesheetMode(
permissions: Pick<CuesheetPermissions, 'canChangeMode'>,
storedMode: AppMode,
{ canRunMode }: CuesheetPolicyOptions,
) {
if (!permissions.canChangeMode) {
return AppMode.Run;
}
return canRunMode ? storedMode : AppMode.Edit;
}
/** /**
* Applies cuesheet permissions to shared state and exposes the effective mode for the UI. * Applies cuesheet permissions to shared state and exposes the effective mode for the UI.
*/ */
export function useApplyCuesheetPolicy( export function useApplyCuesheetPolicy(preset: URLPreset | undefined): {
preset: URLPreset | undefined,
{ canRunMode }: CuesheetPolicyOptions,
): {
cuesheetMode: AppMode; cuesheetMode: AppMode;
setCuesheetMode: (mode: AppMode) => void; setCuesheetMode: (mode: AppMode) => void;
} { } {
@@ -47,14 +26,16 @@ export function useApplyCuesheetPolicy(
defaultValue: preset ? AppMode.Run : AppMode.Edit, defaultValue: preset ? AppMode.Run : AppMode.Edit,
}); });
const cuesheetMode = getEffectiveCuesheetMode(permissions, storedCuesheetMode, { canRunMode }); const cuesheetMode = permissions.canChangeMode ? storedCuesheetMode : AppMode.Run;
const setCuesheetMode = useCallback( const setCuesheetMode = useCallback(
(mode: AppMode) => { (mode: AppMode) => {
if (!permissions.canChangeMode || !canRunMode) return; if (!permissions.canChangeMode) {
return;
}
setStoredCuesheetMode(mode); setStoredCuesheetMode(mode);
}, },
[canRunMode, permissions.canChangeMode, setStoredCuesheetMode], [permissions.canChangeMode, setStoredCuesheetMode],
); );
// Keep the shared permissions store aligned with the active preset policy. // Keep the shared permissions store aligned with the active preset policy.
@@ -1,65 +0,0 @@
import { useSessionStorage } from '@mantine/hooks';
import { startTransition, useCallback, useMemo } from 'react';
import { useNavigate } from 'react-router';
import { useOrderedProjectList } from '../../common/hooks-query/useProjectList';
import { useProjectRundowns } from '../../common/hooks-query/useProjectRundowns';
import { serverURL } from '../../externals';
export const FOLLOW_LOADED_RUNDOWN_ID = '__follow-loaded__' as const;
export function getCuesheetRundownStorageKey(server: string, projectFilename: string) {
return `cuesheet-selected-rundown:${server}:${projectFilename}`;
}
export function resolveSelectedRundownId(storedSelectedRundownId: string | null, availableRundownIds: Set<string>) {
if (storedSelectedRundownId && availableRundownIds.has(storedSelectedRundownId)) return storedSelectedRundownId;
return FOLLOW_LOADED_RUNDOWN_ID;
}
export function useCuesheetRundownSelection() {
'use memo';
const { data: projectRundowns } = useProjectRundowns();
const {
data: { lastLoadedProject },
} = useOrderedProjectList();
const storageKey = useMemo(() => getCuesheetRundownStorageKey(serverURL, lastLoadedProject), [lastLoadedProject]);
const [storedSelectedRundownId, setStoredSelectedRundownId] = useSessionStorage<string | null>({
key: storageKey,
defaultValue: FOLLOW_LOADED_RUNDOWN_ID,
});
const availableRundownIds = new Set(projectRundowns.rundowns.map(({ id }) => id)).add(FOLLOW_LOADED_RUNDOWN_ID);
const { loaded: loadedRundownId } = projectRundowns;
const selectedRundownId = resolveSelectedRundownId(storedSelectedRundownId, availableRundownIds);
return {
loadedRundownId,
selectedRundownId,
projectRundowns: projectRundowns.rundowns,
setSelectedRundownId: (rundownId: string) => {
startTransition(() => {
setStoredSelectedRundownId(rundownId);
});
},
};
}
export function useDirectLinkToBackgroundEdit() {
const {
data: { lastLoadedProject },
} = useOrderedProjectList();
const navigate = useNavigate();
const storageKey = getCuesheetRundownStorageKey(serverURL, lastLoadedProject);
const [_, setStoredSelectedRundownId] = useSessionStorage<string | null>({ key: storageKey, defaultValue: null });
return useCallback(
async (rundownId: string) => {
await navigate('/cuesheet');
startTransition(() => setStoredSelectedRundownId(rundownId));
},
[setStoredSelectedRundownId, navigate],
);
}
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "ontime-electron", "name": "ontime-electron",
"version": "4.9.0", "version": "4.8.0",
"author": "Carlos Valente", "author": "Carlos Valente",
"description": "Time keeping for live events", "description": "Time keeping for live events",
"repository": "https://github.com/cpvalente/ontime", "repository": "https://github.com/cpvalente/ontime",
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "@getontime/resolver", "name": "@getontime/resolver",
"version": "4.9.0", "version": "4.8.0",
"type": "module", "type": "module",
"repository": "https://github.com/cpvalente/ontime", "repository": "https://github.com/cpvalente/ontime",
"types": "./dist/main.d.ts", "types": "./dist/main.d.ts",
+9 -9
View File
@@ -2,21 +2,21 @@
"name": "ontime-server", "name": "ontime-server",
"type": "module", "type": "module",
"main": "src/index.ts", "main": "src/index.ts",
"version": "4.9.0", "version": "4.8.0",
"exports": "./src/index.js", "exports": "./src/index.js",
"dependencies": { "dependencies": {
"@googleapis/sheets": "^5.0.5", "@googleapis/sheets": "^5.0.5",
"cookie": "1.0.2", "cookie": "1.0.2",
"cookie-parser": "1.4.7", "cookie-parser": "1.4.7",
"cors": "2.8.6", "cors": "2.8.5",
"dotenv": "^16.0.1", "dotenv": "^16.0.1",
"express": "5.2.1", "express": "5.1.0",
"express-static-gzip": "3.0.1", "express-static-gzip": "3.0.0",
"express-validator": "7.3.2", "express-validator": "7.2.1",
"fast-equals": "^6.0.0", "fast-equals": "^5.0.1",
"google-auth-library": "^9.4.2", "google-auth-library": "^9.4.2",
"lowdb": "^7.0.1", "lowdb": "^7.0.1",
"multer": "2.2.0", "multer": "2.1.0",
"ontime-utils": "workspace:*", "ontime-utils": "workspace:*",
"osc-min": "2.1.2", "osc-min": "2.1.2",
"sanitize-filename": "^1.6.3", "sanitize-filename": "^1.6.3",
@@ -24,9 +24,9 @@
"xlsx": "^0.18.5" "xlsx": "^0.18.5"
}, },
"devDependencies": { "devDependencies": {
"@types/cookie-parser": "1.4.10", "@types/cookie-parser": "1.4.9",
"@types/cors": "2.8.19", "@types/cors": "2.8.19",
"@types/express": "5.0.6", "@types/express": "5.0.3",
"@types/multer": "2.1.0", "@types/multer": "2.1.0",
"@types/node": "catalog:", "@types/node": "catalog:",
"@types/ws": "^8.5.10", "@types/ws": "^8.5.10",
@@ -1,13 +1,11 @@
import { import {
CustomField, CustomField,
EntryId,
OntimeDelay, OntimeDelay,
OntimeEvent, OntimeEvent,
OntimeGroup, OntimeGroup,
OntimeMilestone, OntimeMilestone,
Rundown, Rundown,
SupportedEntry, SupportedEntry,
isOntimeGroup,
} from 'ontime-types'; } from 'ontime-types';
import { makeNewRundown } from '../../../models/dataModel.js'; import { makeNewRundown } from '../../../models/dataModel.js';
@@ -61,24 +59,13 @@ export function makeOntimeMilestone(patch: Partial<OntimeMilestone>): OntimeMile
} }
/** /**
* Utility to create a rundown object. * Utility to create a rundown object
* Derives flatOrder from order/entries when the patch does not provide one,
* so test fixtures match the shape of a processed rundown.
*/ */
export function makeRundown(patch: Partial<Rundown>): Rundown { export function makeRundown(patch: Partial<Rundown>): Rundown {
const rundown = { ...makeNewRundown(), ...patch }; return {
if (!patch.flatOrder) { ...makeNewRundown(),
const flatOrder: EntryId[] = []; ...patch,
for (const id of rundown.order) { };
flatOrder.push(id);
const entry = rundown.entries[id];
if (isOntimeGroup(entry)) {
flatOrder.push(...entry.entries);
}
}
rundown.flatOrder = flatOrder;
}
return rundown;
} }
export function makeCustomField(patch: Partial<CustomField>): CustomField { export function makeCustomField(patch: Partial<CustomField>): CustomField {
@@ -63,7 +63,7 @@ describe('createTransaction', () => {
expect(typeof commit).toBe('function'); expect(typeof commit).toBe('function');
}); });
it('should return the updated data after commit is called and writes are scheduled', async () => { it('should return the updated data after commit is called and writes are scheduled', () => {
const { rundown, customFields, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: true }); const { rundown, customFields, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: true });
rundown.title = 'Another Title'; rundown.title = 'Another Title';
customFields['newField'] = { customFields['newField'] = {
@@ -72,7 +72,8 @@ describe('createTransaction', () => {
colour: 'blue', colour: 'blue',
}; };
const updated = await commit(); const updated = commit();
vi.runAllTimers();
expect(updated.rundown.title).toBe('Another Title'); expect(updated.rundown.title).toBe('Another Title');
expect(updated.customFields).toHaveProperty('newField'); expect(updated.customFields).toHaveProperty('newField');
@@ -131,23 +132,6 @@ describe('processRundown()', () => {
expect(initResult.entries['3'].type).toBe(SupportedEntry.Delay); expect(initResult.entries['3'].type).toBe(SupportedEntry.Delay);
}); });
it('produces order, flatOrder and applies delays to following events', () => {
const rundown = makeRundown({
order: ['1', 'delay', '2'],
entries: {
'1': makeOntimeEvent({ id: '1', timeStart: 0, timeEnd: 1000, duration: 1000 }),
delay: makeOntimeDelay({ id: 'delay', duration: 250 }),
'2': makeOntimeEvent({ id: '2', timeStart: 1000, timeEnd: 2000, duration: 1000 }),
},
});
const processed = processRundown(rundown, {});
expect(processed.order).toEqual(['1', 'delay', '2']);
expect(processed.flatEntryOrder).toEqual(['1', 'delay', '2']);
expect((processed.entries['2'] as OntimeEvent).delay).toBe(250);
});
it('calculates delays versions of a given rundown', () => { it('calculates delays versions of a given rundown', () => {
const rundown = makeRundown({ const rundown = makeRundown({
order: ['1', '2'], order: ['1', '2'],
@@ -1638,34 +1622,6 @@ describe('rundownMutation.applyDelay()', () => {
}, },
}); });
}); });
it('uses the passed rundown own order, not the loaded rundown metadata', () => {
// The loaded rundown has completely different events
const loadedRundown = makeRundown({
order: ['loaded-delay', 'loaded-ev'],
entries: {
'loaded-delay': makeOntimeDelay({ id: 'loaded-delay', duration: 9999 }),
'loaded-ev': makeOntimeEvent({ id: 'loaded-ev', timeStart: 0, timeEnd: 100, duration: 100 }),
},
});
rundownCache.init(loadedRundown, {});
// Background rundown is independent of the loaded one
const bgRundown = makeRundown({
order: ['bg-delay', 'bg-ev'],
entries: {
'bg-delay': makeOntimeDelay({ id: 'bg-delay', duration: 500 }),
'bg-ev': makeOntimeEvent({ id: 'bg-ev', timeStart: 0, timeEnd: 200, duration: 200 }),
},
});
rundownMutation.applyDelay(bgRundown, bgRundown.entries['bg-delay'] as OntimeDelay);
// bg-ev must be shifted by its own delay (500), not influenced by the loaded rundown
expect((bgRundown.entries['bg-ev'] as OntimeEvent).timeStart).toBe(500);
// loaded-ev must be untouched
expect((loadedRundown.entries['loaded-ev'] as OntimeEvent).timeStart).toBe(0);
});
}); });
describe('rundownMutation.swap()', () => { describe('rundownMutation.swap()', () => {
+93 -123
View File
@@ -82,85 +82,56 @@ export const getEntryWithId = (entryId: EntryId): OntimeEntry | undefined => cac
type Transaction = { type Transaction = {
customFields: CustomFields; customFields: CustomFields;
rundown: Rundown; rundown: Rundown;
rundownMetadata: Readonly<RundownMetadata>;
commit: (shouldProcess?: boolean) => Promise<{ commit: (shouldProcess?: boolean) => {
rundown: Readonly<Rundown>; rundown: Readonly<Rundown>;
rundownMetadata: Readonly<RundownMetadata> | null; rundownMetadata: Readonly<RundownMetadata>;
customFields: Readonly<CustomFields>; customFields: Readonly<CustomFields>;
revision: Readonly<number>; revision: Readonly<number>;
}>; };
}; };
type TransactionOptions = { type TransactionOptions = {
mutableRundown?: boolean; mutableRundown?: boolean;
mutableCustomFields?: boolean; mutableCustomFields?: boolean;
/**
* Target rundown ID. Defaults to the loaded rundown.
* When targeting a non-loaded ("background") rundown, the cache and runtime
* metadata are bypassed — the rundown is read from disk and persisted directly.
*/
rundownId?: string;
}; };
export function createTransaction(options: TransactionOptions): Transaction { export function createTransaction(options: TransactionOptions): Transaction {
const targetId = options.rundownId ?? cachedRundown.id; const rundown = options.mutableRundown ? structuredClone(cachedRundown) : cachedRundown;
const isLoaded = targetId === cachedRundown.id;
const sourceRundown: Rundown = isLoaded ? cachedRundown : (getDataProvider().getRundown(targetId) as Rundown);
const rundown = options.mutableRundown ? structuredClone(sourceRundown) : sourceRundown;
const customFields = options.mutableCustomFields ? structuredClone(projectCustomFields) : projectCustomFields; const customFields = options.mutableCustomFields ? structuredClone(projectCustomFields) : projectCustomFields;
/** /**
* Applies a mutated rundown to its persistence target * Applies a mutated rundown to the cache
* @param shouldProcess - whether the rundown should be processed after the commit * @param shouldProcess - whether the rundown should be processed after the commit
* Some edit mutations, and custom field changes do not require processing * Some edit mutations, and custom field changes do not require processing
*/ */
async function commit(shouldProcess: boolean = true) { function commit(shouldProcess: boolean = true) {
let committedRundown: Readonly<Rundown> = isLoaded ? cachedRundown : rundown;
let committedMetadata: RundownMetadata | null = isLoaded ? rundownMetadata : null;
let committedRevision: number = sourceRundown.revision;
// if the rundown is mutable we persist the changes // if the rundown is mutable we persist the changes
if (options.mutableRundown) { if (options.mutableRundown) {
if (isLoaded) { // update fields which are agnostic of whether the rundown is processed
// update fields which are agnostic of whether the rundown is processed cachedRundown.revision = cachedRundown.revision + 1;
cachedRundown.revision = cachedRundown.revision + 1; cachedRundown.title = rundown.title;
cachedRundown.title = rundown.title;
if (!shouldProcess) { if (!shouldProcess) {
// if we dont need to process, we just reassign the commit data to the cache // if we dont need to process, we just reassign the commit data to the cache
cachedRundown.entries = rundown.entries; cachedRundown.entries = rundown.entries;
cachedRundown.order = rundown.order; cachedRundown.order = rundown.order;
cachedRundown.flatOrder = rundown.flatOrder; cachedRundown.flatOrder = rundown.flatOrder;
} else {
const processedData = processRundown(rundown, projectCustomFields, { mutate: true });
// update the cache values
// eslint-disable-next-line @typescript-eslint/no-unused-vars -- we are not interested in the iteration data
const { previousEvent, latestEvent, previousEntry, entries, order, ...metadata } = processedData;
cachedRundown.entries = entries;
cachedRundown.order = order;
cachedRundown.flatOrder = metadata.flatEntryOrder;
rundownMetadata = metadata;
}
// persist after all mutations are applied
await getDataProvider().setRundown(cachedRundown.id, cachedRundown);
committedRundown = cachedRundown;
committedMetadata = rundownMetadata;
committedRevision = cachedRundown.revision;
} else { } else {
// background rundown: process if requested, persist directly, no runtime metadata const processedData = processRundown(rundown, projectCustomFields);
rundown.revision = rundown.revision + 1; // update the cache values
if (shouldProcess) { // eslint-disable-next-line @typescript-eslint/no-unused-vars -- we are not interested in the iteration data
const processedData = processRundown(rundown, projectCustomFields, { mutate: true }); const { previousEvent, latestEvent, previousEntry, entries, order, ...metadata } = processedData;
rundown.entries = processedData.entries;
rundown.order = processedData.order; cachedRundown.entries = entries;
rundown.flatOrder = processedData.flatEntryOrder; cachedRundown.order = order;
} cachedRundown.flatOrder = metadata.flatEntryOrder;
await getDataProvider().setRundown(targetId, rundown); rundownMetadata = metadata;
committedRundown = rundown;
committedRevision = rundown.revision;
} }
// persist after all mutations are applied
getDataProvider().setRundown(cachedRundown.id, cachedRundown);
} }
// if the customFields are mutable we persist the changes // if the customFields are mutable we persist the changes
@@ -168,20 +139,21 @@ export function createTransaction(options: TransactionOptions): Transaction {
projectCustomFields = customFields; projectCustomFields = customFields;
// persist after reassignment // persist after reassignment
await getDataProvider().setCustomFields(projectCustomFields); getDataProvider().setCustomFields(projectCustomFields);
} }
return { return {
rundown: committedRundown, rundown: cachedRundown,
rundownMetadata: committedMetadata, rundownMetadata,
customFields: projectCustomFields, customFields: projectCustomFields,
revision: committedRevision, revision: cachedRundown.revision,
}; };
} }
return { return {
customFields, customFields,
rundown, rundown,
rundownMetadata,
commit, commit,
}; };
} }
@@ -316,11 +288,11 @@ function reorder(rundown: Rundown, eventFrom: OntimeEntry, eventTo: OntimeEntry,
* Mutates the given rundown * Mutates the given rundown
*/ */
function applyDelay(rundown: Rundown, delay: OntimeDelay) { function applyDelay(rundown: Rundown, delay: OntimeDelay) {
const delayIndex = rundown.flatOrder.indexOf(delay.id); const delayIndex = rundownMetadata.flatEntryOrder.indexOf(delay.id);
// if the delay is empty, or the last element // if the delay is empty, or the last element
// there is nothing do apply // there is nothing do apply
if (delay.duration === 0 || delayIndex === rundown.flatOrder.length - 1) { if (delay.duration === 0 || delayIndex === rundownMetadata.flatEntryOrder.length - 1) {
return; return;
} }
@@ -333,8 +305,8 @@ function applyDelay(rundown: Rundown, delay: OntimeDelay) {
let lastEntry: OntimeEvent | null = null; let lastEntry: OntimeEvent | null = null;
let isFirstEvent = true; let isFirstEvent = true;
for (let i = delayIndex + 1; i < rundown.flatOrder.length; i++) { for (let i = delayIndex + 1; i < rundownMetadata.flatEntryOrder.length; i++) {
const currentId = rundown.flatOrder[i]; const currentId = rundownMetadata.flatEntryOrder[i];
const currentEntry = rundown.entries[currentId]; const currentEntry = rundown.entries[currentId];
// we don't do operation on other event types // we don't do operation on other event types
@@ -616,23 +588,6 @@ export async function updateBackgroundRundown(rundownId: string, rundown: Rundow
await getDataProvider().setRundown(rundownId, rundown); await getDataProvider().setRundown(rundownId, rundown);
} }
/**
* Reads a rundown from disk and returns it in the processed shape used by clients.
* Used for non-loaded rundowns — the loaded rundown is served directly from cache.
*/
export function getProcessedRundown(rundownId: string): Rundown {
const stored = getDataProvider().getRundown(rundownId);
const processed = processRundown(stored, getDataProvider().getCustomFields());
return {
id: stored.id,
title: stored.title,
entries: processed.entries,
order: processed.order,
flatOrder: processed.flatEntryOrder,
revision: stored.revision,
};
}
/** /**
* Adds a new custom field to the object and returns it * Adds a new custom field to the object and returns it
*/ */
@@ -711,7 +666,7 @@ export const customFieldMutation = {
export function init(initialRundown: Readonly<Rundown>, initialCustomFields: Readonly<CustomFields>) { export function init(initialRundown: Readonly<Rundown>, initialCustomFields: Readonly<CustomFields>) {
const rundown = structuredClone(initialRundown); const rundown = structuredClone(initialRundown);
const customFields = structuredClone(initialCustomFields); const customFields = structuredClone(initialCustomFields);
const processedData = processRundown(rundown, customFields, { mutate: true }); const processedData = processRundown(rundown, customFields);
// update the cache values // update the cache values
cachedRundown.id = rundown.id; cachedRundown.id = rundown.id;
@@ -744,57 +699,72 @@ export const rundownCache = {
}; };
/** /**
* Computes derived rundown metadata (delays, gaps, group times, ordered lists). * Utility updates cache after a mutation
* By default the input rundown is not mutated — entries are cloned as they are processed. * Handles calculating the rundown metadata
* Callers that own a writable rundown can pass `{ mutate: true }` to skip the per-entry clone.
* @private should not be called outside of `rundown.dao.ts`, exported for testing * @private should not be called outside of `rundown.dao.ts`, exported for testing
*/ */
export function processRundown( export function processRundown(
initialRundown: Readonly<Rundown>, initialRundown: Readonly<Rundown>,
customFields: Readonly<CustomFields>, customFields: Readonly<CustomFields>,
options?: { mutate?: boolean },
): ProcessedRundownMetadata { ): ProcessedRundownMetadata {
const { process, getMetadata } = makeRundownMetadata(customFields, options); const { process, getMetadata } = makeRundownMetadata(customFields);
for (let i = 0; i < initialRundown.order.length; i++) { for (let i = 0; i < initialRundown.order.length; i++) {
const currentEntry = initialRundown.entries[initialRundown.order[i]]; // we assign a reference to the current entry, this will be mutated in place
if (!currentEntry) continue; const currentEntryId = initialRundown.order[i];
const currentEntry = initialRundown.entries[currentEntryId];
const processedEntry = process(currentEntry, null); if (!currentEntry) {
if (!isOntimeGroup(processedEntry)) continue; continue;
// process nested entries and recompute aggregate group fields
let groupStartTime: number | null = null;
let groupEndTime: number | null = null;
let isFirstLinked = false;
const groupEvents: EntryId[] = [];
processedEntry.duration = 0;
for (let j = 0; j < processedEntry.entries.length; j++) {
const nestedEntry = initialRundown.entries[processedEntry.entries[j]];
if (!nestedEntry) continue;
groupEvents.push(nestedEntry.id);
const processedNestedEntry = process(nestedEntry, processedEntry.id);
// skip metadata aggregation for non-playable nested entries
if (!isOntimeEvent(processedNestedEntry) || !isPlayableEvent(processedNestedEntry)) continue;
if (groupStartTime === null) {
groupStartTime = processedNestedEntry.timeStart;
isFirstLinked = Boolean(processedNestedEntry.linkStart);
}
groupEndTime = processedNestedEntry.timeEnd;
if (j > 0) {
processedEntry.duration += processedNestedEntry.gap;
}
processedEntry.duration += processedNestedEntry.duration;
} }
const { processedEntry } = process(currentEntry, null);
processedEntry.timeStart = groupStartTime; // if the event is a group, we process the nested entries
processedEntry.timeEnd = groupEndTime; // the code here is a copy of the processing of top level events
processedEntry.isFirstLinked = isFirstLinked; if (isOntimeGroup(processedEntry)) {
processedEntry.entries = groupEvents; let groupStartTime = null;
let groupEndTime = null;
let isFirstLinked = false;
const groupEvents: EntryId[] = [];
processedEntry.duration = 0;
// check if the group contains nested entries
for (let j = 0; j < processedEntry.entries.length; j++) {
const nestedEntryId = processedEntry.entries[j];
const nestedEntry = initialRundown.entries[nestedEntryId];
if (!nestedEntry) {
continue;
}
groupEvents.push(nestedEntry.id);
const { processedEntry: processedNestedEntry } = process(nestedEntry, processedEntry.id);
// we dont extract metadata of skipped events,
// if this is not a playable event there is nothing else to do
if (!isOntimeEvent(processedNestedEntry) || !isPlayableEvent(processedNestedEntry)) {
continue;
}
// first start is always the first event
if (groupStartTime === null) {
groupStartTime = processedNestedEntry.timeStart;
isFirstLinked = Boolean(processedNestedEntry.linkStart);
}
// lastEntry is the event with the latest end time
groupEndTime = processedNestedEntry.timeEnd;
if (j > 0) {
processedEntry.duration += processedNestedEntry.gap;
}
processedEntry.duration = processedEntry.duration + processedNestedEntry.duration;
}
// update group metadata
processedEntry.timeStart = groupStartTime;
processedEntry.timeEnd = groupEndTime;
processedEntry.isFirstLinked = isFirstLinked;
processedEntry.entries = groupEvents;
}
} }
return getMetadata(); return getMetadata();
@@ -205,15 +205,10 @@ export type ProcessedRundownMetadata = RundownMetadata & {
/** /**
* Factory function to create a rundown metadata processor * Factory function to create a rundown metadata processor
* * @returns {process, getMetadata} process() - processes entries in order | getMetadata() -> returns the current metadata
* @param customFields project custom fields used to sanitise entries
* @param options.mutate when true, entries are mutated in place rather than cloned.
* Callers must own (or have already cloned) the input rundown.
* @returns process() - processes entries in order | getMetadata() returns the accumulated metadata
*/ */
export function makeRundownMetadata(customFields: CustomFields, options?: { mutate?: boolean }) { export function makeRundownMetadata(customFields: CustomFields) {
const mutate = options?.mutate ?? false; let rundownMeta: ProcessedRundownMetadata = {
const rundownMeta: ProcessedRundownMetadata = {
totalDelay: 0, totalDelay: 0,
totalDuration: 0, totalDuration: 0,
totalDays: 0, totalDays: 0,
@@ -233,8 +228,13 @@ export function makeRundownMetadata(customFields: CustomFields, options?: { muta
previousEntry: null, previousEntry: null,
}; };
function process<T extends OntimeEntry>(entry: T, childOfGroup: EntryId | null): T { function process<T extends OntimeEntry>(
return processEntry(rundownMeta, customFields, mutate ? entry : structuredClone(entry), childOfGroup); entry: T,
childOfGroup: EntryId | null,
): { processedData: ProcessedRundownMetadata; processedEntry: T } {
const data = processEntry(rundownMeta, customFields, entry, childOfGroup);
rundownMeta = data.processedData;
return data;
} }
function getMetadata(): ProcessedRundownMetadata { function getMetadata(): ProcessedRundownMetadata {
@@ -245,19 +245,20 @@ export function makeRundownMetadata(customFields: CustomFields, options?: { muta
} }
/** /**
* Processes a single entry, mutating both `entry` and `rundownMetadata` in place. * Processes a single entry and updates the rundown metadata
* Returns the same `entry` reference for caller convenience.
*/ */
function processEntry<T extends OntimeEntry>( function processEntry<T extends OntimeEntry>(
rundownMetadata: ProcessedRundownMetadata, rundownMetadata: ProcessedRundownMetadata,
customFields: CustomFields, customFields: CustomFields,
entry: T, entry: T,
childOfGroup: EntryId | null, childOfGroup: EntryId | null,
): T { ): { processedData: ProcessedRundownMetadata; processedEntry: T } {
rundownMetadata.flatEntryOrder.push(entry.id); const processedData = { ...rundownMetadata };
const currentEntry = structuredClone(entry);
processedData.flatEntryOrder.push(currentEntry.id);
if (isOntimeEvent(entry)) { if (isOntimeEvent(currentEntry)) {
rundownMetadata.timedEventOrder.push(entry.id); processedData.timedEventOrder.push(currentEntry.id);
/** /**
* 1.Checks that link can be established (ie, events exist and are valid) * 1.Checks that link can be established (ie, events exist and are valid)
@@ -265,91 +266,91 @@ function processEntry<T extends OntimeEntry>(
* The linked event is always the previous playable event * The linked event is always the previous playable event
* If no previous event exists, the link is removed * If no previous event exists, the link is removed
*/ */
if (entry.linkStart) { if (currentEntry.linkStart) {
if (rundownMetadata.previousEvent) { if (processedData.previousEvent) {
const timePatch = getLinkedTimes(entry, rundownMetadata.previousEvent); const timePatch = getLinkedTimes(currentEntry, processedData.previousEvent);
entry.timeStart = timePatch.timeStart; currentEntry.timeStart = timePatch.timeStart;
entry.timeEnd = timePatch.timeEnd; currentEntry.timeEnd = timePatch.timeEnd;
entry.duration = timePatch.duration; currentEntry.duration = timePatch.duration;
} else { } else {
entry.linkStart = false; currentEntry.linkStart = false;
} }
} }
// 2. handle custom fields - mutates entry // 2. handle custom fields - mutates currentEntry
sanitiseCustomFields(customFields, entry); sanitiseCustomFields(customFields, currentEntry);
rundownMetadata.totalDays += calculateDayOffset(entry, rundownMetadata.previousEvent); processedData.totalDays += calculateDayOffset(currentEntry, processedData.previousEvent);
entry.dayOffset = rundownMetadata.totalDays as Day; currentEntry.dayOffset = processedData.totalDays as Day;
entry.delay = 0; // this means we dont calculate delays or gaps for skipped events currentEntry.delay = 0; // this means we dont calculate delays or gaps for skipped events
entry.gap = 0; // this means we dont calculate delays or gaps for skipped events currentEntry.gap = 0; // this means we dont calculate delays or gaps for skipped events
entry.parent = childOfGroup; currentEntry.parent = childOfGroup;
// update rundown metadata, it only concerns playable events // update rundown metadata, it only concerns playable events
if (isPlayableEvent(entry)) { if (isPlayableEvent(currentEntry)) {
rundownMetadata.playableEventOrder.push(entry.id); processedData.playableEventOrder.push(currentEntry.id);
// first start is always the first event // first start is always the first event
if (rundownMetadata.firstStart === null) { if (processedData.firstStart === null) {
rundownMetadata.firstStart = entry.timeStart; processedData.firstStart = currentEntry.timeStart;
} }
// check if event is flagged // check if event is flagged
if (entry.flag) { if (currentEntry.flag) {
rundownMetadata.flags.push(entry.id); processedData.flags.push(currentEntry.id);
} }
entry.gap = getTimeFrom(entry, rundownMetadata.latestEvent); currentEntry.gap = getTimeFrom(currentEntry, processedData.latestEvent);
if (entry.gap === 0) { if (currentEntry.gap === 0) {
// event starts on previous finish, we add its duration // event starts on previous finish, we add its duration
rundownMetadata.totalDuration += entry.duration; processedData.totalDuration += currentEntry.duration;
} else if (entry.gap > 0) { } else if (currentEntry.gap > 0) {
// event has a gap, we add the gap and the duration // event has a gap, we add the gap and the duration
rundownMetadata.totalDuration += entry.gap + entry.duration; processedData.totalDuration += currentEntry.gap + currentEntry.duration;
} else { } else if (currentEntry.gap < 0) {
// there is an overlap, we remove the overlap from the duration // there is an overlap, we remove the overlap from the duration
// ensuring that the sum is not negative (ie: fully overlapped events) // ensuring that the sum is not negative (ie: fully overlapped events)
// NOTE: we add the gap since it is a negative number // NOTE: we add the gap since it is a negative number
rundownMetadata.totalDuration += Math.max(entry.duration + entry.gap, 0); processedData.totalDuration += Math.max(currentEntry.duration + currentEntry.gap, 0);
} }
// remove eventual gaps from the accumulated delay // remove eventual gaps from the accumulated delay
// we only affect positive delays (time forwards) // we only affect positive delays (time forwards)
if (rundownMetadata.totalDelay > 0 && entry.gap > 0) { if (processedData.totalDelay > 0 && currentEntry.gap > 0) {
let correctedDelay = 0; let correctedDelay = 0;
// we need to separate the delay that is accumulated from one that may exist after the gap // we need to separate the delay that is accumulated from one that may exist after the gap
if (isOntimeDelay(rundownMetadata.previousEntry)) { if (isOntimeDelay(processedData.previousEntry)) {
correctedDelay = rundownMetadata.previousEntry.duration; correctedDelay = processedData.previousEntry.duration;
rundownMetadata.totalDelay -= correctedDelay; processedData.totalDelay -= correctedDelay;
} }
rundownMetadata.totalDelay = Math.max(rundownMetadata.totalDelay - entry.gap, 0); processedData.totalDelay = Math.max(processedData.totalDelay - currentEntry.gap, 0);
rundownMetadata.totalDelay += correctedDelay; processedData.totalDelay += correctedDelay;
} }
// current event delay is the current accumulated delay // current event delay is the current accumulated delay
entry.delay = rundownMetadata.totalDelay; currentEntry.delay = processedData.totalDelay;
// assign data for next iteration // assign data for next iteration
rundownMetadata.previousEvent = entry; processedData.previousEvent = currentEntry;
// lastEntry is the event with the latest end time // lastEntry is the event with the latest end time
if (isNewLatest(entry, rundownMetadata.latestEvent)) { if (isNewLatest(currentEntry, processedData.latestEvent)) {
rundownMetadata.latestEvent = entry; processedData.latestEvent = currentEntry;
rundownMetadata.lastEnd = entry.timeEnd; processedData.lastEnd = currentEntry.timeEnd;
} }
} }
} else if (isOntimeDelay(entry)) { } else if (isOntimeDelay(currentEntry)) {
// !!! this must happen after handling the links // !!! this must happen after handling the links
rundownMetadata.totalDelay += entry.duration; processedData.totalDelay += currentEntry.duration;
entry.parent = childOfGroup; currentEntry.parent = childOfGroup;
} }
if (!childOfGroup) { if (!childOfGroup) {
rundownMetadata.order.push(entry.id); processedData.order.push(currentEntry.id);
} }
rundownMetadata.entries[entry.id] = entry; processedData.entries[currentEntry.id] = currentEntry;
rundownMetadata.previousEntry = entry; processedData.previousEntry = currentEntry;
return entry; return { processedData, processedEntry: currentEntry };
} }
@@ -5,14 +5,14 @@ import { ErrorResponse, OntimeEntry, ProjectRundownsList, RenumberCues, Rundown
import { getErrorMessage } from 'ontime-utils'; import { getErrorMessage } from 'ontime-utils';
import { getDataProvider } from '../../classes/data-provider/DataProvider.js'; import { getDataProvider } from '../../classes/data-provider/DataProvider.js';
import { makeNewRundown } from '../../models/dataModel.js';
import { paramsWithId } from '../validation-utils/validationFunction.js'; import { paramsWithId } from '../validation-utils/validationFunction.js';
import { getCurrentRundown, getProcessedRundown } from './rundown.dao.js'; import { getCurrentRundown } from './rundown.dao.js';
import { import {
addEntry, addEntry,
applyDelay, applyDelay,
batchEditEntries, batchEditEntries,
cloneEntry, cloneEntry,
createNewRundown,
deleteAllEntries, deleteAllEntries,
deleteEntries, deleteEntries,
editEntry, editEntry,
@@ -35,6 +35,7 @@ import {
entrySwapValidator, entrySwapValidator,
rundownArrayOfIds, rundownArrayOfIds,
rundownPostValidator, rundownPostValidator,
validateRundownMutation,
} from './rundown.validation.js'; } from './rundown.validation.js';
export const router: Router = express.Router(); export const router: Router = express.Router();
@@ -57,19 +58,6 @@ router.get('/current', async (_req: Request, res: Response<Rundown>) => {
res.json(rundown); res.json(rundown);
}); });
/**
* Returns a given rundown in its normalised client shape
*/
router.get('/:id', paramsWithId, async (req: Request, res: Response<Rundown | ErrorResponse>) => {
try {
const rundown = getProcessedRundown(req.params.id);
res.json(rundown);
} catch (error) {
const message = getErrorMessage(error);
res.status(404).send({ message });
}
});
/** /**
* Loads a given rundown * Loads a given rundown
*/ */
@@ -88,7 +76,11 @@ router.post('/:id/load', paramsWithId, async (req: Request, res: Response<Projec
*/ */
router.post('/', rundownPostValidator, async (req: Request, res: Response<ProjectRundownsList | ErrorResponse>) => { router.post('/', rundownPostValidator, async (req: Request, res: Response<ProjectRundownsList | ErrorResponse>) => {
try { try {
const projectRundowns = await createNewRundown(req.body.title); const emptyRundown = makeNewRundown();
emptyRundown.title = req.body.title;
await getDataProvider().setRundown(emptyRundown.id, emptyRundown);
const projectRundowns = getDataProvider().getProjectRundowns();
res.status(201).json({ loaded: getCurrentRundown().id, rundowns: normalisedToRundownArray(projectRundowns) }); res.status(201).json({ loaded: getCurrentRundown().id, rundowns: normalisedToRundownArray(projectRundowns) });
} catch (error) { } catch (error) {
const message = getErrorMessage(error); const message = getErrorMessage(error);
@@ -188,9 +180,10 @@ router.delete('/:id', paramsWithId, async (req: Request, res: Response<ProjectRu
router.post( router.post(
'/:rundownId/entry', '/:rundownId/entry',
entryPostValidator, entryPostValidator,
validateRundownMutation,
async (req: Request, res: Response<OntimeEntry | ErrorResponse>) => { async (req: Request, res: Response<OntimeEntry | ErrorResponse>) => {
try { try {
const newEvent = await addEntry(req.params.rundownId, req.body); const newEvent = await addEntry(req.body);
res.status(201).send(newEvent); res.status(201).send(newEvent);
} catch (error) { } catch (error) {
const message = getErrorMessage(error); const message = getErrorMessage(error);
@@ -202,15 +195,20 @@ router.post(
/** /**
* Edits an entry in a given rundown * Edits an entry in a given rundown
*/ */
router.put('/:rundownId/entry', entryPutValidator, async (req: Request, res: Response<OntimeEntry | ErrorResponse>) => { router.put(
try { '/:rundownId/entry',
const event = await editEntry(req.params.rundownId, req.body); entryPutValidator,
res.status(200).send(event); validateRundownMutation,
} catch (error) { async (req: Request, res: Response<OntimeEntry | ErrorResponse>) => {
const message = getErrorMessage(error); try {
res.status(400).send({ message }); const event = await editEntry(req.body);
} res.status(200).send(event);
}); } catch (error) {
const message = getErrorMessage(error);
res.status(400).send({ message });
}
},
);
/** /**
* Edits an entry in a given rundown * Edits an entry in a given rundown
@@ -218,9 +216,10 @@ router.put('/:rundownId/entry', entryPutValidator, async (req: Request, res: Res
router.put( router.put(
'/:rundownId/batch', '/:rundownId/batch',
entryBatchPutValidator, entryBatchPutValidator,
validateRundownMutation,
async (req: Request, res: Response<Rundown | ErrorResponse>) => { async (req: Request, res: Response<Rundown | ErrorResponse>) => {
try { try {
const rundown = await batchEditEntries(req.params.rundownId, req.body.ids, req.body.data); const rundown = await batchEditEntries(req.body.ids, req.body.data);
res.status(200).send(rundown); res.status(200).send(rundown);
} catch (error) { } catch (error) {
const message = getErrorMessage(error); const message = getErrorMessage(error);
@@ -235,10 +234,11 @@ router.put(
router.patch( router.patch(
'/:rundownId/reorder', '/:rundownId/reorder',
entryReorderValidator, entryReorderValidator,
validateRundownMutation,
async (req: Request, res: Response<Rundown | ErrorResponse>) => { async (req: Request, res: Response<Rundown | ErrorResponse>) => {
try { try {
const { entryId, destinationId, order } = req.body; const { entryId, destinationId, order } = req.body;
const rundown = await reorderEntry(req.params.rundownId, entryId, destinationId, order); const rundown = await reorderEntry(entryId, destinationId, order);
res.status(200).send(rundown); res.status(200).send(rundown);
} catch (error) { } catch (error) {
const message = getErrorMessage(error); const message = getErrorMessage(error);
@@ -253,9 +253,10 @@ router.patch(
router.patch( router.patch(
'/:rundownId/applydelay/:id', '/:rundownId/applydelay/:id',
paramsWithId, paramsWithId,
validateRundownMutation,
async (req: Request, res: Response<Rundown | ErrorResponse>) => { async (req: Request, res: Response<Rundown | ErrorResponse>) => {
try { try {
const rundown = await applyDelay(req.params.rundownId, req.params.id); const rundown = await applyDelay(req.params.id);
res.status(200).send(rundown); res.status(200).send(rundown);
} catch (error) { } catch (error) {
const message = getErrorMessage(error); const message = getErrorMessage(error);
@@ -267,15 +268,20 @@ router.patch(
/** /**
* Swaps data between two Ontime events * Swaps data between two Ontime events
*/ */
router.patch('/:rundownId/swap', entrySwapValidator, async (req: Request, res: Response<Rundown | ErrorResponse>) => { router.patch(
try { '/:rundownId/swap',
const rundown = await swapEvents(req.params.rundownId, req.body.from, req.body.to); entrySwapValidator,
res.status(200).send(rundown); validateRundownMutation,
} catch (error) { async (req: Request, res: Response<Rundown | ErrorResponse>) => {
const message = getErrorMessage(error); try {
res.status(400).send({ message }); const rundown = await swapEvents(req.body.from, req.body.to);
} res.status(200).send(rundown);
}); } catch (error) {
const message = getErrorMessage(error);
res.status(400).send({ message });
}
},
);
/** /**
* Clones the contents of an entry into a new one * Clones the contents of an entry into a new one
@@ -284,9 +290,10 @@ router.post(
'/:rundownId/clone/:id', '/:rundownId/clone/:id',
paramsWithId, paramsWithId,
clonePostValidator, clonePostValidator,
validateRundownMutation,
async (req: Request, res: Response<Rundown | ErrorResponse>) => { async (req: Request, res: Response<Rundown | ErrorResponse>) => {
try { try {
const rundown = await cloneEntry(req.params.rundownId, req.params.id, { const rundown = await cloneEntry(req.params.id, {
before: req.body?.before, before: req.body?.before,
after: req.body?.after, after: req.body?.after,
}); });
@@ -301,28 +308,38 @@ router.post(
/** /**
* Creates a group out of a list of entries * Creates a group out of a list of entries
*/ */
router.post('/:rundownId/group', rundownArrayOfIds, async (req: Request, res: Response<Rundown | ErrorResponse>) => { router.post(
try { '/:rundownId/group',
const rundown = await groupEntries(req.params.rundownId, req.body.ids); rundownArrayOfIds,
res.status(200).send(rundown); validateRundownMutation,
} catch (error) { async (req: Request, res: Response<Rundown | ErrorResponse>) => {
const message = getErrorMessage(error); try {
res.status(400).send({ message }); const rundown = await groupEntries(req.body.ids);
} res.status(200).send(rundown);
}); } catch (error) {
const message = getErrorMessage(error);
res.status(400).send({ message });
}
},
);
/** /**
* Dissolves a group by moving its children to the main rundown * Dissolves a group by moving its children to the main rundown
*/ */
router.post('/:rundownId/ungroup/:id', paramsWithId, async (req: Request, res: Response<Rundown | ErrorResponse>) => { router.post(
try { '/:rundownId/ungroup/:id',
const rundown = await ungroupEntries(req.params.rundownId, req.params.id); paramsWithId,
res.status(200).send(rundown); validateRundownMutation,
} catch (error) { async (req: Request, res: Response<Rundown | ErrorResponse>) => {
const message = getErrorMessage(error); try {
res.status(400).send({ message }); const rundown = await ungroupEntries(req.params.id);
} res.status(200).send(rundown);
}); } catch (error) {
const message = getErrorMessage(error);
res.status(400).send({ message });
}
},
);
/** /**
* Deletes a list of entries by their ID * Deletes a list of entries by their ID
@@ -330,9 +347,10 @@ router.post('/:rundownId/ungroup/:id', paramsWithId, async (req: Request, res: R
router.delete( router.delete(
'/:rundownId/entries', '/:rundownId/entries',
rundownArrayOfIds, rundownArrayOfIds,
validateRundownMutation,
async (req: Request, res: Response<Rundown | ErrorResponse>) => { async (req: Request, res: Response<Rundown | ErrorResponse>) => {
try { try {
const rundown = await deleteEntries(req.params.rundownId, req.body.ids); const rundown = await deleteEntries(req.body.ids);
res.status(200).send(rundown); res.status(200).send(rundown);
} catch (error) { } catch (error) {
const message = getErrorMessage(error); const message = getErrorMessage(error);
@@ -344,15 +362,19 @@ router.delete(
/** /**
* Deletes all entries in a given rundown * Deletes all entries in a given rundown
*/ */
router.delete('/:rundownId/all', async (req: Request, res: Response<Rundown | ErrorResponse>) => { router.delete(
try { '/:rundownId/all',
const rundown = await deleteAllEntries(req.params.rundownId); validateRundownMutation,
res.status(200).send(rundown); async (_req: Request, res: Response<Rundown | ErrorResponse>) => {
} catch (error) { try {
const message = getErrorMessage(error); const rundown = await deleteAllEntries();
res.status(400).send({ message }); res.status(200).send(rundown);
} } catch (error) {
}); const message = getErrorMessage(error);
res.status(400).send({ message });
}
},
);
/** /**
* Reorders two entries in a rundown * Reorders two entries in a rundown
@@ -360,10 +382,11 @@ router.delete('/:rundownId/all', async (req: Request, res: Response<Rundown | Er
router.patch( router.patch(
'/:rundownId/renumber', '/:rundownId/renumber',
entryRenumberValidator, entryRenumberValidator,
async (req: Request, res: Response<Rundown | ErrorResponse>) => { validateRundownMutation,
(req: Request, res: Response<Rundown | ErrorResponse>) => {
try { try {
const { ids, prefix, start, increment } = matchedData<RenumberCues>(req); const { ids, prefix, start, increment } = matchedData<RenumberCues>(req);
const rundown = await renumberEntries(req.params.rundownId, ids, prefix, start, increment); const rundown = renumberEntries(ids, prefix, start, increment);
res.status(200).send(rundown); res.status(200).send(rundown);
} catch (error) { } catch (error) {
const message = getErrorMessage(error); const message = getErrorMessage(error);
@@ -21,7 +21,6 @@ import { customFieldLabelToKey, getInsertAfterId, resolveInsertParent } from 'on
import { sendRefetch } from '../../adapters/WebsocketAdapter.js'; import { sendRefetch } from '../../adapters/WebsocketAdapter.js';
import { getDataProvider } from '../../classes/data-provider/DataProvider.js'; import { getDataProvider } from '../../classes/data-provider/DataProvider.js';
import { logger } from '../../classes/Logger.js'; import { logger } from '../../classes/Logger.js';
import { makeNewRundown } from '../../models/dataModel.js';
import { setLastLoadedRundown } from '../../services/app-state-service/AppStateService.js'; import { setLastLoadedRundown } from '../../services/app-state-service/AppStateService.js';
import { runtimeService } from '../../services/runtime-service/runtime.service.js'; import { runtimeService } from '../../services/runtime-service/runtime.service.js';
import { updateRundownData } from '../../stores/runtimeState.js'; import { updateRundownData } from '../../stores/runtimeState.js';
@@ -39,8 +38,8 @@ import { generateEvent, getIntegerAndFraction, hasChanges } from './rundown.util
/** /**
* creates a new entry with given data * creates a new entry with given data
*/ */
export async function addEntry(rundownId: string, eventData: EventPostPayload): Promise<OntimeEntry> { export async function addEntry(eventData: EventPostPayload): Promise<OntimeEntry> {
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true }); const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
// we allow the user to provide an ID, but make sure it is unique // we allow the user to provide an ID, but make sure it is unique
if (eventData?.id && Object.hasOwn(rundown.entries, eventData.id)) { if (eventData?.id && Object.hasOwn(rundown.entries, eventData.id)) {
@@ -67,7 +66,7 @@ export async function addEntry(rundownId: string, eventData: EventPostPayload):
// make mutations to rundown // make mutations to rundown
rundownMutation.add(rundown, newEntry, afterId, parent); rundownMutation.add(rundown, newEntry, afterId, parent);
const { rundown: responseRundown, rundownMetadata, revision } = await commit(); const { rundownMetadata, revision } = commit();
// schedule the side effects // schedule the side effects
setImmediate(() => { setImmediate(() => {
@@ -78,14 +77,14 @@ export async function addEntry(rundownId: string, eventData: EventPostPayload):
notifyChanges(rundown.id, rundownMetadata, revision, { timer: [newEntry.id], external: true }); notifyChanges(rundown.id, rundownMetadata, revision, { timer: [newEntry.id], external: true });
}); });
return responseRundown.entries[newEntry.id] ?? newEntry; return newEntry;
} }
/** /**
* Applies a patch to an entry in the rundown * Applies a patch to an entry in the rundown
*/ */
export async function editEntry(rundownId: string, patch: PatchWithId): Promise<OntimeEntry> { export async function editEntry(patch: PatchWithId): Promise<OntimeEntry> {
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true }); const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
const currentEntry = rundown.entries[patch.id]; const currentEntry = rundown.entries[patch.id];
/** /**
@@ -111,7 +110,7 @@ export async function editEntry(rundownId: string, patch: PatchWithId): Promise<
} }
const { entry, didInvalidate } = rundownMutation.edit(rundown, patch); const { entry, didInvalidate } = rundownMutation.edit(rundown, patch);
const { rundown: responseRundown, rundownMetadata, revision } = await commit(didInvalidate); const { rundownMetadata, revision } = commit(didInvalidate);
// schedule the side effects // schedule the side effects
setImmediate(() => { setImmediate(() => {
@@ -125,18 +124,14 @@ export async function editEntry(rundownId: string, patch: PatchWithId): Promise<
}); });
}); });
return responseRundown.entries[entry.id] ?? entry; return entry;
} }
/** /**
* Applies a patch to several entries in the rundown * Applies a patch to several entries in the rundown
*/ */
export async function batchEditEntries( export async function batchEditEntries(ids: EntryId[], patch: Partial<OntimeEntry>): Promise<Rundown> {
rundownId: string, const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
ids: EntryId[],
patch: Partial<OntimeEntry>,
): Promise<Rundown> {
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true });
/** /**
* We can do some validation globally, but mostly we will validate each entry individually * We can do some validation globally, but mostly we will validate each entry individually
@@ -181,7 +176,7 @@ export async function batchEditEntries(
batchDidInvalidate = true; batchDidInvalidate = true;
} }
} }
const { rundown: rundownResult, rundownMetadata, revision } = await commit(batchDidInvalidate); const { rundown: rundownResult, rundownMetadata, revision } = commit(batchDidInvalidate);
// schedule the side effects // schedule the side effects
setImmediate(() => { setImmediate(() => {
@@ -201,8 +196,8 @@ export async function batchEditEntries(
/** /**
* Deletes a known entry from the current rundown * Deletes a known entry from the current rundown
*/ */
export async function deleteEntries(rundownId: string, entryIds: EntryId[]): Promise<Rundown> { export async function deleteEntries(entryIds: EntryId[]): Promise<Rundown> {
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true }); const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
for (let i = 0; i < entryIds.length; i++) { for (let i = 0; i < entryIds.length; i++) {
const entry = rundown.entries[entryIds[i]]; const entry = rundown.entries[entryIds[i]];
@@ -212,7 +207,7 @@ export async function deleteEntries(rundownId: string, entryIds: EntryId[]): Pro
rundownMutation.remove(rundown, entry); rundownMutation.remove(rundown, entry);
} }
const { rundown: rundownResult, rundownMetadata, revision } = await commit(); const { rundown: rundownResult, rundownMetadata, revision } = commit();
// schedule the side effects // schedule the side effects
setImmediate(() => { setImmediate(() => {
@@ -229,12 +224,12 @@ export async function deleteEntries(rundownId: string, entryIds: EntryId[]): Pro
/** /**
* Deletes all entries from the current rundown * Deletes all entries from the current rundown
*/ */
export async function deleteAllEntries(rundownId: string): Promise<Rundown> { export async function deleteAllEntries(): Promise<Rundown> {
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true }); const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
rundownMutation.removeAll(rundown); rundownMutation.removeAll(rundown);
const { rundown: rundownResult, rundownMetadata, revision } = await commit(); const { rundown: rundownResult, rundownMetadata, revision } = commit();
// schedule the side effects // schedule the side effects
setImmediate(() => { setImmediate(() => {
@@ -253,13 +248,8 @@ export async function deleteAllEntries(rundownId: string): Promise<Rundown> {
* Handles moving across root orders (a group order and top level order) * Handles moving across root orders (a group order and top level order)
* @throws if entryId or destinationId not found * @throws if entryId or destinationId not found
*/ */
export async function reorderEntry( export async function reorderEntry(entryId: EntryId, destinationId: EntryId, order: 'before' | 'after' | 'insert') {
rundownId: string, const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
entryId: EntryId,
destinationId: EntryId,
order: 'before' | 'after' | 'insert',
) {
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true });
// check that both entries exist // check that both entries exist
const eventFrom = rundown.entries[entryId]; const eventFrom = rundown.entries[entryId];
@@ -271,7 +261,7 @@ export async function reorderEntry(
rundownMutation.reorder(rundown, eventFrom, eventTo, order); rundownMutation.reorder(rundown, eventFrom, eventTo, order);
const { rundown: rundownResult, rundownMetadata, revision } = await commit(); const { rundown: rundownResult, rundownMetadata, revision } = commit();
// schedule the side effects // schedule the side effects
setImmediate(() => { setImmediate(() => {
@@ -288,24 +278,18 @@ export async function reorderEntry(
/** /**
* @throws if an id is missing or not an Ontime event * @throws if an id is missing or not an Ontime event
*/ */
export async function renumberEntries( export function renumberEntries(ids: EntryId[], prefix: string, start: string, increment: string): Rundown {
rundownId: string,
ids: EntryId[],
prefix: string,
start: string,
increment: string,
): Promise<Rundown> {
const startNumber = getIntegerAndFraction(start); const startNumber = getIntegerAndFraction(start);
const incrementNumber = getIntegerAndFraction(increment); const incrementNumber = getIntegerAndFraction(increment);
// if the prefix doesn't already include a separator or is empty, then insert a separator // if the prefix doesn't already include a separator or is empty, then insert a separator
if (prefix !== '' && !prefix.endsWith('-') && !prefix.endsWith(' ')) prefix += ' '; if (prefix !== '' && !prefix.endsWith('-') && !prefix.endsWith(' ')) prefix += ' ';
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true, mutableCustomFields: false }); const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
rundownMutation.renumber(rundown, ids, prefix, startNumber, incrementNumber); rundownMutation.renumber(rundown, ids, prefix, startNumber, incrementNumber);
const { rundown: rundownResult, rundownMetadata, revision } = await commit(false); const { rundown: rundownResult, rundownMetadata, revision } = commit(false);
setImmediate(() => { setImmediate(() => {
updateRuntimeOnChange(rundownMetadata); updateRuntimeOnChange(rundownMetadata);
@@ -319,8 +303,8 @@ export async function renumberEntries(
* Applies a delay into the rundown effectively changing the schedule * Applies a delay into the rundown effectively changing the schedule
* The applied delay is deleted * The applied delay is deleted
*/ */
export async function applyDelay(rundownId: string, delayId: EntryId): Promise<Rundown> { export async function applyDelay(delayId: EntryId): Promise<Rundown> {
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true }); const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
// check that delay exists // check that delay exists
const delay = rundown.entries[delayId]; const delay = rundown.entries[delayId];
@@ -332,7 +316,7 @@ export async function applyDelay(rundownId: string, delayId: EntryId): Promise<R
rundownMutation.applyDelay(rundown, delay); rundownMutation.applyDelay(rundown, delay);
rundownMutation.remove(rundown, delay); rundownMutation.remove(rundown, delay);
const { rundown: rundownResult, rundownMetadata, revision } = await commit(); const { rundown: rundownResult, rundownMetadata, revision } = commit();
// schedule the side effects // schedule the side effects
setImmediate(() => { setImmediate(() => {
@@ -349,8 +333,8 @@ export async function applyDelay(rundownId: string, delayId: EntryId): Promise<R
/** /**
* Swaps the data between two events in the rundown * Swaps the data between two events in the rundown
*/ */
export async function swapEvents(rundownId: string, fromId: EntryId, toId: EntryId): Promise<Rundown> { export async function swapEvents(fromId: EntryId, toId: EntryId): Promise<Rundown> {
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true }); const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
const eventFrom = rundown.entries[fromId]; const eventFrom = rundown.entries[fromId];
const eventTo = rundown.entries[toId]; const eventTo = rundown.entries[toId];
@@ -365,7 +349,7 @@ export async function swapEvents(rundownId: string, fromId: EntryId, toId: Entry
} }
rundownMutation.swap(rundown, eventFrom, eventTo); rundownMutation.swap(rundown, eventFrom, eventTo);
const { rundown: rundownResult, rundownMetadata, revision } = await commit(); const { rundown: rundownResult, rundownMetadata, revision } = commit();
// schedule the side effects // schedule the side effects
setImmediate(() => { setImmediate(() => {
@@ -384,8 +368,8 @@ export async function swapEvents(rundownId: string, fromId: EntryId, toId: Entry
* Handles cloning children if the entry is a group * Handles cloning children if the entry is a group
* @throws if the entry to clone does not exist * @throws if the entry to clone does not exist
*/ */
export async function cloneEntry(rundownId: string, entryId: EntryId, options: InsertOptions): Promise<Rundown> { export async function cloneEntry(entryId: EntryId, options: InsertOptions): Promise<Rundown> {
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true }); const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
const originalEntry = rundown.entries[entryId]; const originalEntry = rundown.entries[entryId];
if (!originalEntry) { if (!originalEntry) {
@@ -393,7 +377,7 @@ export async function cloneEntry(rundownId: string, entryId: EntryId, options: I
} }
const newEntry = rundownMutation.clone(rundown, originalEntry, options); const newEntry = rundownMutation.clone(rundown, originalEntry, options);
const { rundown: rundownResult, rundownMetadata, revision } = await commit(); const { rundown: rundownResult, rundownMetadata, revision } = commit();
// schedule the side effects // schedule the side effects
setImmediate(() => { setImmediate(() => {
@@ -416,11 +400,11 @@ export async function cloneEntry(rundownId: string, entryId: EntryId, options: I
/** /**
* Groups a list of entries into a new group * Groups a list of entries into a new group
*/ */
export async function groupEntries(rundownId: string, entryIds: EntryId[]): Promise<Rundown> { export async function groupEntries(entryIds: EntryId[]): Promise<Rundown> {
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true }); const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
rundownMutation.group(rundown, entryIds); rundownMutation.group(rundown, entryIds);
const { rundown: rundownResult, rundownMetadata, revision } = await commit(); const { rundown: rundownResult, rundownMetadata, revision } = commit();
// schedule the side effects // schedule the side effects
setImmediate(() => { setImmediate(() => {
@@ -437,8 +421,8 @@ export async function groupEntries(rundownId: string, entryIds: EntryId[]): Prom
/** /**
* Deletes a group and moves all its children to the top level * Deletes a group and moves all its children to the top level
*/ */
export async function ungroupEntries(rundownId: string, groupId: EntryId): Promise<Rundown> { export async function ungroupEntries(groupId: EntryId): Promise<Rundown> {
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true }); const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
const group = rundown.entries[groupId]; const group = rundown.entries[groupId];
if (!group || !isOntimeGroup(group)) { if (!group || !isOntimeGroup(group)) {
@@ -446,7 +430,7 @@ export async function ungroupEntries(rundownId: string, groupId: EntryId): Promi
} }
rundownMutation.ungroup(rundown, group); rundownMutation.ungroup(rundown, group);
const { rundown: rundownResult, rundownMetadata, revision } = await commit(); const { rundown: rundownResult, rundownMetadata, revision } = commit();
// schedule the side effects // schedule the side effects
setImmediate(() => { setImmediate(() => {
@@ -481,7 +465,7 @@ export async function createCustomField(customField: CustomField): Promise<Custo
customFieldMutation.add(customFields, key, customField); customFieldMutation.add(customFields, key, customField);
// Adding a custom field has no immediate implications on the rundown // Adding a custom field has no immediate implications on the rundown
const { customFields: resultCustomFields } = await commit(false); const { customFields: resultCustomFields } = commit(false);
setImmediate(() => { setImmediate(() => {
sendRefetch(RefetchKey.CustomFields); sendRefetch(RefetchKey.CustomFields);
@@ -539,7 +523,7 @@ export async function editCustomField(
} }
// the custom fields have been removed and there is no processing to be done // the custom fields have been removed and there is no processing to be done
const { rundownMetadata, revision, customFields: resultCustomFields } = await commit(false); const { rundownMetadata, revision, customFields: resultCustomFields } = commit(false);
// schedule the side effects // schedule the side effects
setImmediate(() => { setImmediate(() => {
@@ -578,7 +562,7 @@ export async function deleteCustomField(key: CustomFieldKey, projectRundowns: Pr
customFieldMutation.remove(customFields, key); customFieldMutation.remove(customFields, key);
// the custom fields have been removed and there is no processing to be done // the custom fields have been removed and there is no processing to be done
const { rundownMetadata, revision, customFields: resultCustomFields } = await commit(false); const { rundownMetadata, revision, customFields: resultCustomFields } = commit(false);
// schedule the side effects // schedule the side effects
setImmediate(() => { setImmediate(() => {
@@ -595,8 +579,7 @@ export async function deleteCustomField(key: CustomFieldKey, projectRundowns: Pr
* *
* @private - exported for testing * @private - exported for testing
*/ */
export function updateRuntimeOnChange(rundownMetadata: RundownMetadata | null) { export function updateRuntimeOnChange(rundownMetadata: RundownMetadata) {
if (!rundownMetadata) return;
// we only declare the amount of playable events // we only declare the amount of playable events
const numEvents = rundownMetadata.timedEventOrder.length; const numEvents = rundownMetadata.timedEventOrder.length;
@@ -620,15 +603,16 @@ type NotifyChangesOptions = {
*/ */
function notifyChanges( function notifyChanges(
rundownId: string | undefined, rundownId: string | undefined,
rundownMetadata: RundownMetadata | null, rundownMetadata: RundownMetadata,
revision: number, revision: number,
options: NotifyChangesOptions, options: NotifyChangesOptions,
) { ) {
// notify timer service of changed event // notify timer service of changed event
if (rundownMetadata && options.timer && rundownId && isCurrentRundown(rundownId)) { if (options.timer && rundownId && isCurrentRundown(rundownId)) {
runtimeService.notifyOfChangedEvents(rundownMetadata); runtimeService.notifyOfChangedEvents(rundownMetadata);
} }
// notify external services of changes
if (options.reload) { if (options.reload) {
sendRefetch(RefetchKey.All); sendRefetch(RefetchKey.All);
} else if (options.external) { } else if (options.external) {
@@ -672,23 +656,8 @@ export async function initRundown(
setImmediate(() => { setImmediate(() => {
notifyChanges(rundown.id, rundownMetadata, revision, { timer: true, external: true, reload }); notifyChanges(rundown.id, rundownMetadata, revision, { timer: true, external: true, reload });
sendRefetch(RefetchKey.ProjectRundowns);
setLastLoadedRundown(rundown.id).catch((error) => { setLastLoadedRundown(rundown.id).catch((error) => {
logger.error(LogOrigin.Server, `Failed to persist last loaded rundown: ${error}`); logger.error(LogOrigin.Server, `Failed to persist last loaded rundown: ${error}`);
}); });
}); });
} }
export async function createNewRundown(title: string) {
const emptyRundown = makeNewRundown();
emptyRundown.title = title;
await getDataProvider().setRundown(emptyRundown.id, emptyRundown);
const projectRundowns = getDataProvider().getProjectRundowns();
setImmediate(() => {
sendRefetch(RefetchKey.ProjectRundowns);
});
return projectRundowns;
}
@@ -1,6 +1,8 @@
import type { NextFunction, Request, Response } from 'express';
import { body, param } from 'express-validator'; import { body, param } from 'express-validator';
import { requestValidationFunction } from '../validation-utils/validationFunction.js'; import { requestValidationFunction } from '../validation-utils/validationFunction.js';
import { getCurrentRundown } from './rundown.dao.js';
// #region operations on project rundowns ========================= // #region operations on project rundowns =========================
@@ -9,6 +11,29 @@ export const rundownPostValidator = [body('title').isString().trim().notEmpty(),
// #endregion operations on project rundowns ====================== // #endregion operations on project rundowns ======================
// #region operations on rundown entries ========================== // #region operations on rundown entries ==========================
/**
* Middleware prevents mutating a rundown that is not selected
* This allows our service to still only handle the current rundown
*
* This would need to be removed in favour or rundown selection if we would like
* to implement the mutation of background rundowns
*/
export async function validateRundownMutation(req: Request, res: Response, next: NextFunction) {
const { rundownId } = req.params;
try {
if (getCurrentRundown().id !== rundownId) {
res.status(404).json({ message: 'Cannot mutate not selected rundown' });
return;
}
next();
} catch (error) {
res.status(404).json({ message: 'Rundown not found' });
return;
}
}
export const entryPostValidator = [ export const entryPostValidator = [
body('type').isString().isIn(['event', 'delay', 'group', 'milestone']), body('type').isString().isIn(['event', 'delay', 'group', 'milestone']),
body('after').optional().isString(), body('after').optional().isString(),
@@ -63,7 +63,7 @@ const actionHandlers: Record<ApiActionTag, ActionHandler> = {
throw new Error('Missing Event ID'); throw new Error('Missing Event ID');
} }
const { entries, id: currentRundownId } = getCurrentRundown(); const { entries } = getCurrentRundown();
const customFields = getProjectCustomFields(); const customFields = getProjectCustomFields();
const targetEntry = entries[id]; const targetEntry = entries[id];
@@ -89,8 +89,8 @@ const actionHandlers: Record<ApiActionTag, ActionHandler> = {
Object.assign(patchEntry, newObjectProperty); Object.assign(patchEntry, newObjectProperty);
} }
}); });
//TODO: windowed edit function
await editEntry(currentRundownId, patchEntry); await editEntry(patchEntry);
return { payload: 'success' }; return { payload: 'success' };
}, },
/* Message Service */ /* Message Service */
@@ -245,52 +245,6 @@ describe('mutation on runtimeState', () => {
expect(newState.offset.expectedRundownEnd).toBeNull(); expect(newState.offset.expectedRundownEnd).toBeNull();
}); });
test('a countToEnd last event absorbs overtime into its fixed rundown end', async () => {
const tenAM = 10 * MILLIS_PER_HOUR;
const elevenAM = 11 * MILLIS_PER_HOUR;
const noon = 12 * MILLIS_PER_HOUR;
const entries = {
event1: {
...mockEvent,
id: 'event1',
timeStart: tenAM,
timeEnd: elevenAM,
duration: MILLIS_PER_HOUR,
parent: null,
},
event2: {
...mockEvent,
id: 'event2',
timeStart: elevenAM,
timeEnd: noon,
duration: MILLIS_PER_HOUR,
countToEnd: true,
linkStart: true,
parent: null,
},
};
const mockRundown = makeRundown({ entries, order: ['event1', 'event2'] });
await initRundown(mockRundown, {});
vi.runAllTimers();
const { metadata, rundown } = rundownCache.get();
// start event1 five minutes behind schedule
vi.setSystemTime('jan 1 10:05');
load(entries.event1, rundown, metadata);
start();
update();
const newState = getState();
expect(newState.offset.absolute).toBe(5 * MILLIS_PER_MINUTE);
// without countToEnd the rundown would end at noon + 5min, but the countToEnd
// event absorbs the overtime so the rundown is still expected to end at noon
expect(newState.offset.expectedRundownEnd).toBe(noon);
});
test('resume restores currentDay from restore point', async () => { test('resume restores currentDay from restore point', async () => {
clearState(); clearState();
const mockRundown = makeRundown({ const mockRundown = makeRundown({
@@ -1002,32 +956,4 @@ describe('loadGroupFlagAndEnd()', () => {
eventNow: rundown.entries[0], eventNow: rundown.entries[0],
}); });
}); });
test('a countToEnd event breaks the link chain for the events that follow it', () => {
// chain: A (loaded) -> B (countToEnd, flagged) -> C (linked, last event)
// the chain stays intact up to and including B, but breaks for C since it follows a countToEnd event
const rundown = makeRundown({
entries: {
A: makeOntimeEvent({ id: 'A', parent: null, linkStart: false, countToEnd: false, gap: 0 }),
B: makeOntimeEvent({ id: 'B', parent: null, linkStart: true, countToEnd: true, gap: 0, flag: true }),
C: makeOntimeEvent({ id: 'C', parent: null, linkStart: true, countToEnd: false, gap: 0 }),
},
order: ['A', 'B', 'C'],
});
const state = {
groupNow: null,
eventNow: rundown.entries.A,
rundown: { actualGroupStart: null },
} as RuntimeState;
const metadata = { playableEventOrder: ['A', 'B', 'C'], flags: ['B'] } as RundownMetadata;
loadGroupFlagAndEnd(rundown, metadata, 0, state);
// the flag (B) is still part of the chain
expect(state._flag).toMatchObject({ event: rundown.entries.B, isLinkedToLoaded: true });
// the rundown end (C) follows the countToEnd event, so the chain is broken
expect(state._end).toMatchObject({ event: rundown.entries.C, isLinkedToLoaded: false });
});
}); });
+7 -10
View File
@@ -23,7 +23,6 @@ import {
calculateDuration, calculateDuration,
checkIsNow, checkIsNow,
dayInMs, dayInMs,
getExpectedEnd,
getExpectedStart, getExpectedStart,
getLastEventNormal, getLastEventNormal,
isPlaybackActive, isPlaybackActive,
@@ -837,8 +836,8 @@ function getExpectedTimes(state = runtimeState) {
const { _group } = state; const { _group } = state;
if (_group !== null) { if (_group !== null) {
const { event: lastEvent, accumulatedGap, isLinkedToLoaded } = _group; const { event: lastEvent, accumulatedGap, isLinkedToLoaded } = _group;
state.offset.expectedGroupEnd = getExpectedEnd(lastEvent, { const lastEventExpectedStart = getExpectedStart(lastEvent, {
currentDay: state.rundown.currentDay ?? 0, currentDay: state.rundown.currentDay!,
totalGap: accumulatedGap, totalGap: accumulatedGap,
isLinkedToLoaded, isLinkedToLoaded,
mode: offset.mode, mode: offset.mode,
@@ -846,6 +845,7 @@ function getExpectedTimes(state = runtimeState) {
plannedStart, plannedStart,
actualStart, actualStart,
}); });
state.offset.expectedGroupEnd = lastEventExpectedStart + lastEvent.duration;
} }
} }
@@ -868,8 +868,8 @@ function getExpectedTimes(state = runtimeState) {
if (state._end) { if (state._end) {
const { event, accumulatedGap, isLinkedToLoaded } = state._end; const { event, accumulatedGap, isLinkedToLoaded } = state._end;
state.offset.expectedRundownEnd = getExpectedEnd(event, { const expectedStart = getExpectedStart(event, {
currentDay: state.rundown.currentDay ?? 0, currentDay: state.rundown.currentDay!,
totalGap: accumulatedGap, totalGap: accumulatedGap,
isLinkedToLoaded, isLinkedToLoaded,
mode: offset.mode, mode: offset.mode,
@@ -877,6 +877,7 @@ function getExpectedTimes(state = runtimeState) {
plannedStart, plannedStart,
actualStart, actualStart,
}); });
state.offset.expectedRundownEnd = expectedStart + event.duration;
} }
} }
@@ -919,8 +920,6 @@ export function loadGroupFlagAndEnd(
let accumulatedGap = 0; let accumulatedGap = 0;
let isLinkedToLoaded = true; let isLinkedToLoaded = true;
// a countToEnd event absorbs overtime and breaks the chain
let previousWasCountToEnd = false;
for (let idx = currentIndex; idx < playableEventOrder.length; idx++) { for (let idx = currentIndex; idx < playableEventOrder.length; idx++) {
const entry = entries[playableEventOrder[idx]]; const entry = entries[playableEventOrder[idx]];
@@ -929,7 +928,7 @@ export function loadGroupFlagAndEnd(
if (idx !== currentIndex) { if (idx !== currentIndex) {
// we only accumulate data after the loaded event // we only accumulate data after the loaded event
accumulatedGap += entry.gap; accumulatedGap += entry.gap;
isLinkedToLoaded = isLinkedToLoaded && entry.linkStart && !previousWasCountToEnd; isLinkedToLoaded = isLinkedToLoaded && entry.linkStart;
// and the loaded event is not allowed to be the next flag // and the loaded event is not allowed to be the next flag
if (!foundFlag && metadata.flags.includes(entry.id)) { if (!foundFlag && metadata.flags.includes(entry.id)) {
@@ -943,8 +942,6 @@ export function loadGroupFlagAndEnd(
foundGroupEnd = true; foundGroupEnd = true;
state._group = { event: lastEventInGroup, isLinkedToLoaded, accumulatedGap }; state._group = { event: lastEventInGroup, isLinkedToLoaded, accumulatedGap };
} }
previousWasCountToEnd = entry.countToEnd;
} }
} }
-69
View File
@@ -6,51 +6,6 @@ test('cuesheet displays events', async ({ page }) => {
await expect(page.getByTestId('cuesheet-event').first()).toBeVisible(); await expect(page.getByTestId('cuesheet-event').first()).toBeVisible();
}); });
test('cuesheet datagrid does not submit timer cells on tab-out or escape', async ({ page }) => {
await page.goto('/cuesheet');
const firstEvent = page.getByTestId('cuesheet-event').first();
await expect(firstEvent).toBeVisible();
const durationCell = firstEvent.getByTestId('cuesheet-cell-duration');
/**
* 1. Tab out of a timer cell should not submit the typed value
*/
await durationCell.click();
const durationInput = durationCell.locator('input');
await expect(durationInput).toBeVisible();
const originalDuration = await durationInput.inputValue();
await durationInput.fill('01:00:00');
await durationInput.press('Tab');
// cell should exit edit mode without submitting
await expect(durationInput).not.toBeVisible();
// re-enter edit mode: original value should be unchanged
await durationCell.click();
await expect(durationCell.locator('input')).toHaveValue(originalDuration);
await durationCell.locator('input').press('Escape');
/**
* 2. Escape on a timer cell should not submit, should revert to original value
*/
await durationCell.click();
await expect(durationCell.locator('input')).toBeVisible();
await durationCell.locator('input').fill('02:00:00');
await durationCell.locator('input').press('Escape');
// cell should exit edit mode without submitting
await expect(durationCell.locator('input')).not.toBeVisible();
// re-enter edit mode: original value should be unchanged
await durationCell.click();
await expect(durationCell.locator('input')).toHaveValue(originalDuration);
await durationCell.locator('input').press('Escape');
});
test('cuesheet datagrid keeps keyboard focus flow while editing text cells', async ({ page }) => { test('cuesheet datagrid keeps keyboard focus flow while editing text cells', async ({ page }) => {
await page.goto('/cuesheet'); await page.goto('/cuesheet');
@@ -100,27 +55,3 @@ test('cuesheet datagrid keeps keyboard focus flow while editing text cells', asy
await expect(cueEditor).not.toBeFocused(); await expect(cueEditor).not.toBeFocused();
await expect(cueEditor).toHaveValue(cueBeforeCancel); await expect(cueEditor).toHaveValue(cueBeforeCancel);
}); });
test('cuesheet background edit from empty state', async ({ page }) => {
// create an empty rundown
await page.goto('/editor');
await page.getByRole('button', { name: 'Toggle settings' }).click();
await page.getByRole('button', { name: 'Manage rundowns' }).click();
await page.getByRole('button', { name: 'New' }).nth(1).click();
const emptyName = `empty-${Date.now()}`;
await page.getByRole('textbox', { name: 'Rundown title' }).fill(emptyName);
await page.getByRole('button', { name: 'Create rundown' }).click();
// edit it in the cuesheet
await page.getByRole('row', { name: '0 empty-' }).getByTestId('rundown_menu').click();
await page.getByText('Edit in cuesheet').click();
// expect to see and empty screen
await expect(page.getByRole('button', { name: 'Create Event' })).toBeVisible();
// create 1 event
await page.getByRole('button', { name: 'Create Event' }).click();
// and expect to find it
await expect(page.getByTestId('cuesheet-event')).toBeVisible();
});
+6 -6
View File
@@ -1,6 +1,6 @@
{ {
"name": "ontime", "name": "ontime",
"version": "4.9.0", "version": "4.8.0",
"description": "Time keeping for live events", "description": "Time keeping for live events",
"keywords": [ "keywords": [
"ontime", "ontime",
@@ -32,16 +32,16 @@
"dist-win": "turbo run dist-win --filter=ontime-electron", "dist-win": "turbo run dist-win --filter=ontime-electron",
"dist-mac": "turbo run dist-mac --filter=ontime-electron", "dist-mac": "turbo run dist-mac --filter=ontime-electron",
"dist-linux": "turbo run dist-linux --filter=ontime-electron", "dist-linux": "turbo run dist-linux --filter=ontime-electron",
"e2e": "turbo run build --filter=ontime-ui && pnpm clear-temp && cross-env DEBUG=pw:webserver pnpm playwright test -c playwright.config.ts", "e2e": "turbo run build --filter=ontime-ui && pnpm clear-temp && cross-env DEBUG=pw:webserver npx playwright test -c playwright.config.ts",
"e2e:ui": "cross-env NODE_ENV=development cross-env DEBUG=pw:webserver pnpm playwright test --ui -c playwright.config.ts", "e2e:ui": "cross-env NODE_ENV=development cross-env DEBUG=pw:webserver npx playwright test --ui -c playwright.config.ts",
"e2e:i": "pnpm playwright codegen", "e2e:i": "npx playwright codegen",
"clear-temp": "rimraf e2e/tests/fixtures/tmp", "clear-temp": "rimraf e2e/tests/fixtures/tmp",
"test": "turbo run test:pipeline", "test": "turbo run test:pipeline",
"format": "oxfmt", "format": "oxfmt",
"format:check": "oxfmt --check" "format:check": "oxfmt --check"
}, },
"devDependencies": { "devDependencies": {
"@playwright/test": "1.60.0", "@playwright/test": "^1.58.2",
"@types/node": "catalog:", "@types/node": "catalog:",
"cross-env": "^7.0.3", "cross-env": "^7.0.3",
"oxfmt": "^0.42.0", "oxfmt": "^0.42.0",
@@ -55,7 +55,7 @@
"devEngines": { "devEngines": {
"runtime": { "runtime": {
"name": "node", "name": "node",
"version": "22.22.3" "version": "22.22.2"
} }
} }
} }
+1 -1
View File
@@ -1,5 +1,5 @@
{ {
"version": "4.9.0", "version": "4.8.0",
"name": "ontime-types", "name": "ontime-types",
"type": "module", "type": "module",
"main": "./src/index.ts", "main": "./src/index.ts",
@@ -2,7 +2,6 @@ export enum RefetchKey {
All = 'all', All = 'all',
CustomFields = 'custom-fields', CustomFields = 'custom-fields',
ProjectData = 'project-data', ProjectData = 'project-data',
ProjectRundowns = 'project-rundowns',
Report = 'report', Report = 'report',
Rundown = 'rundown', Rundown = 'rundown',
UrlPresets = 'url-presets', UrlPresets = 'url-presets',
+1 -1
View File
@@ -80,7 +80,7 @@ export { validateEndAction, validateTimerType } from './src/validate-events/vali
// feature business logic // feature business logic
export { getExpectedStart, getExpectedEnd } from './src/date-utils/getExpected.js'; export { getExpectedStart } from './src/date-utils/getExpectedStart.js';
// feature business logic - rundown // feature business logic - rundown
export { checkIsNow } from './src/date-utils/checkIsNow.js'; export { checkIsNow } from './src/date-utils/checkIsNow.js';
@@ -1,7 +1,7 @@
import { Day, OffsetMode } from 'ontime-types'; import { Day, OffsetMode } from 'ontime-types';
import { MILLIS_PER_HOUR, dayInMs } from './conversionUtils'; import { MILLIS_PER_HOUR, dayInMs } from './conversionUtils';
import { getExpectedEnd, getExpectedStart } from './getExpected'; import { getExpectedStart } from './getExpectedStart';
describe('getExpectedStart()', () => { describe('getExpectedStart()', () => {
describe('Absolute offset mode', () => { describe('Absolute offset mode', () => {
@@ -315,123 +315,3 @@ describe('getExpectedStart()', () => {
expect(getExpectedStart(testEvent, { ...testState, currentDay: 0 })).toBe(23 * MILLIS_PER_HOUR + 5); expect(getExpectedStart(testEvent, { ...testState, currentDay: 0 })).toBe(23 * MILLIS_PER_HOUR + 5);
}); });
}); });
describe('getExpectedEnd()', () => {
const baseState = {
currentDay: 0,
totalGap: 0,
mode: OffsetMode.Absolute,
actualStart: null,
plannedStart: null,
isLinkedToLoaded: true,
};
test('a regular event ends at its expected start plus duration', () => {
const testEvent = {
timeStart: 100,
duration: 50,
delay: 0,
dayOffset: 0 as Day,
countToEnd: false,
};
// on schedule
expect(getExpectedEnd(testEvent, { ...baseState, offset: 0 })).toBe(150);
// running 20 behind pushes the end out
expect(getExpectedEnd(testEvent, { ...baseState, offset: 20 })).toBe(170);
});
test('a countToEnd event pins to the planned end while in overtime', () => {
const testEvent = {
timeStart: 100,
duration: 50,
delay: 0,
dayOffset: 0 as Day,
countToEnd: true,
};
// overtime would otherwise push the end to 170, but countToEnd absorbs it and pins to 150
expect(getExpectedEnd(testEvent, { ...baseState, offset: 20 })).toBe(150);
});
test('a countToEnd event pins to the planned end while ahead of schedule', () => {
const testEvent = {
timeStart: 100,
duration: 50,
delay: 0,
dayOffset: 0 as Day,
countToEnd: true,
};
// ahead of schedule the start moves earlier (90) but the end stays pinned to 150
expect(getExpectedEnd(testEvent, { ...baseState, offset: -10 })).toBe(150);
});
test('an overnight countToEnd event returns a normalised end', () => {
// event starts at 23:00 and counts to 01:00 the next day -> duration spans midnight
const timeStart = 23 * MILLIS_PER_HOUR;
const duration = 2 * MILLIS_PER_HOUR;
const testEvent = {
timeStart,
duration,
delay: 0,
dayOffset: 0 as Day,
countToEnd: true,
};
expect(getExpectedEnd(testEvent, { ...baseState, offset: 0 })).toBe(timeStart + duration);
});
test('a countToEnd event drifts when the start is compromised', () => {
const testEvent = {
timeStart: 100,
duration: 50,
delay: 0,
dayOffset: 0 as Day,
countToEnd: true,
};
// the offset pushes the start (160) past the scheduled end (150) so it can no longer
// finish on schedule - the end follows the compromised start
expect(getExpectedEnd(testEvent, { ...baseState, offset: 60 })).toBe(160);
});
test('a countToEnd event on a later day keeps the day offset on the end', () => {
const testEvent = {
timeStart: 100,
duration: 50,
delay: 0,
dayOffset: 1 as Day,
countToEnd: true,
};
// the scheduled end must include the day offset (delayedStart + dayInMs + duration),
// not collapse to the day-shifted start
expect(getExpectedEnd(testEvent, { ...baseState, currentDay: 0, offset: 0 })).toBe(150 + dayInMs);
// when the running event is already on the same day, no extra day is added
expect(getExpectedEnd({ ...testEvent, dayOffset: 0 as Day }, { ...baseState, currentDay: 0, offset: 0 })).toBe(150);
});
test('a countToEnd event is anchored to its wall-clock end in relative mode', () => {
const testEvent = {
timeStart: 100,
duration: 50,
delay: 0,
dayOffset: 0 as Day,
countToEnd: true,
};
const relativeState = {
...baseState,
mode: OffsetMode.Relative,
actualStart: 30,
plannedStart: 0,
offset: 0,
};
// a regular event in the same state is shifted by the relative-start offset to 180
expect(getExpectedEnd({ ...testEvent, countToEnd: false }, relativeState)).toBe(180);
// the countToEnd event stays pinned to its wall-clock end (150), not shifted
expect(getExpectedEnd(testEvent, relativeState)).toBe(150);
});
});
@@ -8,6 +8,7 @@ import { dayInMs } from './conversionUtils.js';
* @param currentDay the day offset of the currently running event * @param currentDay the day offset of the currently running event
* @param totalGap accumulated gap from the current event * @param totalGap accumulated gap from the current event
* @param isLinkedToLoaded is this event part of a chain linking back to the current loaded event * @param isLinkedToLoaded is this event part of a chain linking back to the current loaded event
* @param clock
* @param offset * @param offset
* @returns * @returns
*/ */
@@ -59,39 +60,3 @@ export function getExpectedStart(
const offsetStartTimeBufferedByGaps = offsetStartTime - totalGap; const offsetStartTimeBufferedByGaps = offsetStartTime - totalGap;
return offsetStartTimeBufferedByGaps; return offsetStartTimeBufferedByGaps;
} }
/**
* @param event the event that we are counting to
* @param currentDay the day offset of the currently running event
* @param totalGap accumulated gap from the current event
* @param isLinkedToLoaded is this event part of a chain linking back to the current loaded event
* @param offset
* @returns
*/
export function getExpectedEnd(
event: Pick<OntimeEvent, 'timeStart' | 'dayOffset' | 'delay' | 'duration' | 'countToEnd'>,
state: {
currentDay: number; // the current day from the rundown
totalGap: number;
isLinkedToLoaded: boolean;
offset: number;
mode: OffsetMode;
actualStart: MaybeNumber;
plannedStart: MaybeNumber;
},
): number {
// expected start encodes the offset from current delays
const expectedStart = getExpectedStart(event, state);
// count to end events should finish on schedule unlesss the start is compromised
if (event.countToEnd) {
// the scheduled end, normalised to the same day-space as expectedStart
// (a raw timeStart + duration would miss the day offset on multi-day rundowns)
const delayedStart = Math.max(0, event.timeStart + event.delay);
const relativeDayOffset = event.dayOffset - state.currentDay;
const scheduledEnd = delayedStart + relativeDayOffset * dayInMs + event.duration;
return Math.max(expectedStart, scheduledEnd);
}
return expectedStart + event.duration;
}
+292 -386
View File
File diff suppressed because it is too large Load Diff