mirror of
https://github.com/cpvalente/ontime.git
synced 2026-08-16 12:53:32 +00:00
Compare commits
19 Commits
v4.8.0
...
v4.9.1-beta.1
| Author | SHA1 | Date | |
|---|---|---|---|
| 05c000118b | |||
| daf2cf67f4 | |||
| 6633cfc869 | |||
| d127367df9 | |||
| b21ec41ffd | |||
| 66292bc0cf | |||
| b946b245c2 | |||
| c238147b75 | |||
| 5f33c993f6 | |||
| 0e6d6cd416 | |||
| 199dea5df6 | |||
| 5a3ea9f7d0 | |||
| 9ae49a7175 | |||
| d30d9cfd4e | |||
| a0e7b9b665 | |||
| 1dcb7fb08d | |||
| a7e84b9903 | |||
| 3bebbf9ce9 | |||
| ab8da07518 |
@@ -20,13 +20,13 @@ jobs:
|
|||||||
node-version-file: '.nvmrc'
|
node-version-file: '.nvmrc'
|
||||||
|
|
||||||
- name: Setup pnpm
|
- name: Setup pnpm
|
||||||
uses: pnpm/action-setup@v4
|
uses: pnpm/action-setup@v6
|
||||||
|
|
||||||
- name: Get pnpm store directory
|
- name: Get pnpm store directory
|
||||||
run: echo "PNPM_STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
run: echo "PNPM_STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
||||||
|
|
||||||
- name: Setup pnpm cache
|
- name: Setup pnpm cache
|
||||||
uses: actions/cache@v4
|
uses: actions/cache@v5
|
||||||
with:
|
with:
|
||||||
path: ${{ env.PNPM_STORE_PATH }}
|
path: ${{ env.PNPM_STORE_PATH }}
|
||||||
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
|
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
|
||||||
|
|||||||
@@ -15,13 +15,13 @@ jobs:
|
|||||||
- uses: actions/checkout@v6
|
- uses: actions/checkout@v6
|
||||||
|
|
||||||
- name: Setup pnpm
|
- name: Setup pnpm
|
||||||
uses: pnpm/action-setup@v4
|
uses: pnpm/action-setup@v6
|
||||||
|
|
||||||
- name: Get pnpm store directory
|
- name: Get pnpm store directory
|
||||||
run: echo "PNPM_STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
run: echo "PNPM_STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
||||||
|
|
||||||
- name: Setup pnpm cache
|
- name: Setup pnpm cache
|
||||||
uses: actions/cache@v4
|
uses: actions/cache@v5
|
||||||
with:
|
with:
|
||||||
path: ${{ env.PNPM_STORE_PATH }}
|
path: ${{ env.PNPM_STORE_PATH }}
|
||||||
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
|
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
|
||||||
|
|||||||
@@ -17,13 +17,13 @@ jobs:
|
|||||||
node-version-file: '.nvmrc'
|
node-version-file: '.nvmrc'
|
||||||
|
|
||||||
- name: Setup pnpm
|
- name: Setup pnpm
|
||||||
uses: pnpm/action-setup@v4
|
uses: pnpm/action-setup@v6
|
||||||
|
|
||||||
- name: Get pnpm store directory
|
- name: Get pnpm store directory
|
||||||
run: echo "PNPM_STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
run: echo "PNPM_STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
||||||
|
|
||||||
- name: Setup pnpm cache
|
- name: Setup pnpm cache
|
||||||
uses: actions/cache@v4
|
uses: actions/cache@v5
|
||||||
with:
|
with:
|
||||||
path: ${{ env.PNPM_STORE_PATH }}
|
path: ${{ env.PNPM_STORE_PATH }}
|
||||||
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
|
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
|
||||||
@@ -74,7 +74,7 @@ jobs:
|
|||||||
node-version-file: '.nvmrc'
|
node-version-file: '.nvmrc'
|
||||||
|
|
||||||
- name: Setup pnpm
|
- name: Setup pnpm
|
||||||
uses: pnpm/action-setup@v4
|
uses: pnpm/action-setup@v6
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: pnpm install --frozen-lockfile
|
run: pnpm install --frozen-lockfile
|
||||||
@@ -111,7 +111,7 @@ jobs:
|
|||||||
node-version-file: '.nvmrc'
|
node-version-file: '.nvmrc'
|
||||||
|
|
||||||
- name: Setup pnpm
|
- name: Setup pnpm
|
||||||
uses: pnpm/action-setup@v4
|
uses: pnpm/action-setup@v6
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: pnpm install --frozen-lockfile
|
run: pnpm install --frozen-lockfile
|
||||||
|
|||||||
@@ -18,13 +18,13 @@ jobs:
|
|||||||
node-version-file: '.nvmrc'
|
node-version-file: '.nvmrc'
|
||||||
|
|
||||||
- name: Setup pnpm
|
- name: Setup pnpm
|
||||||
uses: pnpm/action-setup@v4
|
uses: pnpm/action-setup@v6
|
||||||
|
|
||||||
- name: Get pnpm store directory
|
- name: Get pnpm store directory
|
||||||
run: echo "PNPM_STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
run: echo "PNPM_STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
||||||
|
|
||||||
- name: Setup pnpm cache
|
- name: Setup pnpm cache
|
||||||
uses: actions/cache@v4
|
uses: actions/cache@v5
|
||||||
with:
|
with:
|
||||||
path: ${{ env.PNPM_STORE_PATH }}
|
path: ${{ env.PNPM_STORE_PATH }}
|
||||||
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
|
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
|
||||||
|
|||||||
@@ -15,14 +15,18 @@ 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@v4
|
uses: pnpm/action-setup@v6
|
||||||
|
|
||||||
- name: Get pnpm store directory
|
- name: Get pnpm store directory
|
||||||
run: echo "PNPM_STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
run: echo "PNPM_STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
||||||
|
|
||||||
- name: Setup pnpm cache
|
- name: Setup pnpm cache
|
||||||
uses: actions/cache@v4
|
uses: actions/cache@v5
|
||||||
with:
|
with:
|
||||||
path: ${{ env.PNPM_STORE_PATH }}
|
path: ${{ env.PNPM_STORE_PATH }}
|
||||||
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
|
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
|
||||||
@@ -54,14 +58,18 @@ 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@v4
|
uses: pnpm/action-setup@v6
|
||||||
|
|
||||||
- name: Get pnpm store directory
|
- name: Get pnpm store directory
|
||||||
run: echo "PNPM_STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
run: echo "PNPM_STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
||||||
|
|
||||||
- name: Setup pnpm cache
|
- name: Setup pnpm cache
|
||||||
uses: actions/cache@v4
|
uses: actions/cache@v5
|
||||||
with:
|
with:
|
||||||
path: ${{ env.PNPM_STORE_PATH }}
|
path: ${{ env.PNPM_STORE_PATH }}
|
||||||
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
|
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('pnpm-lock.yaml') }}
|
||||||
@@ -74,18 +82,18 @@ jobs:
|
|||||||
- name: Get installed Playwright version
|
- name: Get installed Playwright version
|
||||||
run: echo "PLAYWRIGHT_VERSION=$(pnpm ls @playwright/test --parseable | cut -s -d '@' -f3 | cut -d '/' -f1)" >> $GITHUB_ENV
|
run: echo "PLAYWRIGHT_VERSION=$(pnpm ls @playwright/test --parseable | cut -s -d '@' -f3 | cut -d '/' -f1)" >> $GITHUB_ENV
|
||||||
- name: Cache playwright binaries
|
- name: Cache playwright binaries
|
||||||
uses: actions/cache@v4
|
uses: actions/cache@v5
|
||||||
with:
|
with:
|
||||||
path: |
|
path: |
|
||||||
~/.cache/ms-playwright
|
~/.cache/ms-playwright
|
||||||
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: npx playwright install --with-deps
|
- run: pnpm 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: npx playwright install --with-deps
|
run: pnpm playwright install --with-deps
|
||||||
|
|
||||||
- name: Run Playwright tests
|
- name: Run Playwright tests
|
||||||
run: pnpm e2e
|
run: pnpm e2e
|
||||||
|
|||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
ARG NODE_VERSION=22.15.1
|
ARG NODE_VERSION=22.22.2
|
||||||
FROM node:${NODE_VERSION}-alpine
|
FROM node:${NODE_VERSION}-alpine
|
||||||
|
|
||||||
# Set environment variables
|
# Set environment variables
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@getontime/cli",
|
"name": "@getontime/cli",
|
||||||
"version": "4.8.0",
|
"version": "4.9.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",
|
||||||
|
|||||||
+17
-18
@@ -1,10 +1,10 @@
|
|||||||
{
|
{
|
||||||
"name": "ontime-ui",
|
"name": "ontime-ui",
|
||||||
"version": "4.8.0",
|
"version": "4.9.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@base-ui/react": "1.3.0",
|
"@base-ui/react": "1.6.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,28 +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.6",
|
"@fontsource/open-sans": "^5.2.7",
|
||||||
"@mantine/hooks": "^8.3.7",
|
"@mantine/hooks": "^8.3.7",
|
||||||
"@sentry/react": "^10.2.0",
|
"@sentry/react": "^10.59.0",
|
||||||
"@table-nav/react": "^0.0.7",
|
"@table-nav/react": "^0.0.7",
|
||||||
"@tanstack/react-query": "^5.85.9",
|
"@tanstack/react-query": "^5.101.0",
|
||||||
"@tanstack/react-query-devtools": "^5.85.9",
|
"@tanstack/react-query-devtools": "^5.101.0",
|
||||||
"@tanstack/react-table": "^8.21.3",
|
"@tanstack/react-table": "^8.21.3",
|
||||||
"@uiw/codemirror-theme-vscode": "^4.25.9",
|
"@uiw/codemirror-theme-vscode": "^4.25.10",
|
||||||
"autosize": "^6.0.1",
|
"autosize": "^6.0.1",
|
||||||
"axios": "^1.12.2",
|
"axios": "^1.18.0",
|
||||||
"csv-stringify": "^6.6.0",
|
"csv-stringify": "^6.6.0",
|
||||||
"qrcode": "^1.5.4",
|
"qrcode": "^1.5.4",
|
||||||
"react": "^19.2.3",
|
"react": "^19.2.7",
|
||||||
"react-colorful": "^5.6.1",
|
"react-colorful": "^5.7.0",
|
||||||
"react-dom": "^19.2.3",
|
"react-dom": "^19.2.7",
|
||||||
"react-fast-compare": "^3.2.2",
|
"react-fast-compare": "^3.2.2",
|
||||||
"react-hook-form": "^7.72.0",
|
"react-hook-form": "^7.80.0",
|
||||||
"react-icons": "5.5.0",
|
"react-icons": "5.6.0",
|
||||||
"react-router": "^7.11.0",
|
"react-router": "^8.0.1",
|
||||||
"react-virtuoso": "^4.17.0",
|
"react-virtuoso": "^4.18.7",
|
||||||
"web-vitals": "^5.1.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",
|
||||||
@@ -68,6 +67,7 @@
|
|||||||
"@vitejs/plugin-legacy": "^8.0.1",
|
"@vitejs/plugin-legacy": "^8.0.1",
|
||||||
"@vitejs/plugin-react": "5.2.0",
|
"@vitejs/plugin-react": "5.2.0",
|
||||||
"babel-plugin-react-compiler": "1.0.0",
|
"babel-plugin-react-compiler": "1.0.0",
|
||||||
|
"happy-dom": "^20.9.0",
|
||||||
"ontime-types": "workspace:*",
|
"ontime-types": "workspace:*",
|
||||||
"ontime-utils": "workspace:*",
|
"ontime-utils": "workspace:*",
|
||||||
"sass": "^1.57.1",
|
"sass": "^1.57.1",
|
||||||
@@ -75,7 +75,6 @@
|
|||||||
"vite": "8.0.1",
|
"vite": "8.0.1",
|
||||||
"vite-plugin-compression2": "2.5.1",
|
"vite-plugin-compression2": "2.5.1",
|
||||||
"vite-plugin-svgr": "4.5.0",
|
"vite-plugin-svgr": "4.5.0",
|
||||||
"vite-tsconfig-paths": "6.1.1",
|
|
||||||
"vitest": "catalog:"
|
"vitest": "catalog:"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -34,19 +34,17 @@ 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 {
|
/**
|
||||||
return (
|
* HTTP request to fetch all entries in the given rundown
|
||||||
x &&
|
*/
|
||||||
typeof x === 'object' &&
|
export async function fetchRundown(rundownId: RundownId, options?: RequestOptions): Promise<Rundown> {
|
||||||
typeof x.id === 'string' &&
|
const res = await axios.get(`${rundownPath}/${rundownId}`, { signal: options?.signal });
|
||||||
Array.isArray(x.order) &&
|
if (!isValidRundown(res.data)) {
|
||||||
Array.isArray(x.flatOrder) &&
|
throw new Error('Invalid rundown payload');
|
||||||
x.entries &&
|
|
||||||
typeof x.entries === 'object' &&
|
|
||||||
typeof x.revision === 'number'
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
return res.data;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -197,3 +195,16 @@ 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) => void;
|
onChange: (event: ChangeEvent<HTMLInputElement | HTMLTextAreaElement>) => void;
|
||||||
onBlur: (event: ChangeEvent) => void;
|
onBlur: (event: ChangeEvent<HTMLInputElement | HTMLTextAreaElement>) => void;
|
||||||
onKeyDown: (event: KeyboardEvent<HTMLElement>) => void;
|
onKeyDown: (event: KeyboardEvent<HTMLElement>) => void;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -15,7 +15,9 @@ 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;
|
||||||
},
|
},
|
||||||
@@ -23,6 +25,10 @@ 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') {
|
||||||
@@ -78,6 +84,7 @@ 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
|
||||||
@@ -141,16 +148,30 @@ 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, text]);
|
}, [handleEscape, handleSubmit, options?.submitOnCtrlEnter, options?.submitOnEnter, options?.submitOnTab, text]);
|
||||||
|
|
||||||
return {
|
return {
|
||||||
value: text,
|
value: text,
|
||||||
onChange: (event: ChangeEvent) => handleChange((event.target as HTMLInputElement).value),
|
onChange: (event) => handleChange(event.target.value),
|
||||||
onBlur: (event: ChangeEvent) => {
|
onBlur: (event) => {
|
||||||
|
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 as HTMLInputElement).value);
|
handleSubmit(event.target.value);
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
onKeyDown: keyHandler,
|
onKeyDown: keyHandler,
|
||||||
|
|||||||
@@ -8,9 +8,12 @@
|
|||||||
padding-top: 10vh;
|
padding-top: 10vh;
|
||||||
}
|
}
|
||||||
|
|
||||||
.empty {
|
.inline {
|
||||||
width: 100%;
|
display: flex;
|
||||||
opacity: 0.8;
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
gap: 1rem;
|
||||||
|
margin-top: 1em;
|
||||||
}
|
}
|
||||||
|
|
||||||
.text {
|
.text {
|
||||||
|
|||||||
@@ -1,18 +1,33 @@
|
|||||||
import EmptyImage from '../../../assets/images/empty.svg?react';
|
import { SupportedEntry } from 'ontime-types';
|
||||||
|
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 {
|
||||||
text: string;
|
handleAddNew?: (type: SupportedEntry) => void;
|
||||||
}
|
}
|
||||||
|
|
||||||
export default function EmptyTableBody({ text }: EmptyTableBodyProps) {
|
export default function EmptyTableBody({ handleAddNew }: 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}>
|
||||||
<EmptyImage className={style.empty} />
|
<Empty injectedStyles={{ marginTop: '5vh' }} />
|
||||||
{text && <span className={style.text}>{text}</span>}
|
<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,6 +12,7 @@ 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 } from '../api/rundown';
|
import { fetchCurrentRundown, fetchRundown } 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,7 +20,11 @@ const cachedRundownPlaceholder: Rundown = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Normalised rundown data
|
* Normalised rundown data for the currently loaded rundown.
|
||||||
|
*
|
||||||
|
* 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();
|
||||||
@@ -34,12 +38,13 @@ export default function useRundown() {
|
|||||||
refetchInterval: queryRefetchIntervalSlow,
|
refetchInterval: queryRefetchIntervalSlow,
|
||||||
});
|
});
|
||||||
|
|
||||||
// Seed the ID-based cache when fetching via the 'current' alias (bootstrap)
|
// Seed the id-keyed cache when fetching via the bootstrap alias
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
if (!data || loadedRundownId) return;
|
if (!data || loadedRundownId) return;
|
||||||
queryClient.setQueryData(getRundownQueryKey(data.id), data);
|
queryClient.setQueryData(getRundownQueryKey(data.id), data);
|
||||||
}, [data, loadedRundownId, queryClient]);
|
}, [data, loadedRundownId, queryClient]);
|
||||||
|
|
||||||
|
// Once we have the ID, drop the temporary current cache
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
if (!loadedRundownId) return;
|
if (!loadedRundownId) return;
|
||||||
queryClient.removeQueries({ queryKey: CURRENT_RUNDOWN_QUERY_KEY, exact: true });
|
queryClient.removeQueries({ queryKey: CURRENT_RUNDOWN_QUERY_KEY, exact: true });
|
||||||
@@ -114,3 +119,21 @@ 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 };
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,54 @@
|
|||||||
|
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],
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -63,9 +63,16 @@ export type EventOptions = Partial<{
|
|||||||
}>;
|
}>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gather utilities for actions on entries
|
* Gather utilities for actions on entries in the loaded rundown.
|
||||||
*/
|
*/
|
||||||
export const useEntryActions = () => {
|
export const useEntryActions = () => useEntryActionsForRundown(undefined);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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,
|
||||||
@@ -78,12 +85,12 @@ export const useEntryActions = () => {
|
|||||||
} = useEditorSettings();
|
} = useEditorSettings();
|
||||||
|
|
||||||
const resolveCurrentRundownQueryKey = useCallback(() => {
|
const resolveCurrentRundownQueryKey = useCallback(() => {
|
||||||
const loadedRundownId = queryClient.getQueryData<ProjectRundownsList>(PROJECT_RUNDOWNS)?.loaded;
|
if (scopedRundownId !== undefined) {
|
||||||
if (loadedRundownId) {
|
return getRundownQueryKey(scopedRundownId);
|
||||||
return getRundownQueryKey(loadedRundownId);
|
|
||||||
}
|
}
|
||||||
return CURRENT_RUNDOWN_QUERY_KEY;
|
const loadedRundownId = queryClient.getQueryData<ProjectRundownsList>(PROJECT_RUNDOWNS)?.loaded;
|
||||||
}, [queryClient]);
|
return loadedRundownId ? getRundownQueryKey(loadedRundownId) : CURRENT_RUNDOWN_QUERY_KEY;
|
||||||
|
}, [queryClient, scopedRundownId]);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the currently loaded rundown
|
* Returns the currently loaded rundown
|
||||||
@@ -1004,7 +1011,7 @@ export const useEntryActions = () => {
|
|||||||
updateTimer,
|
updateTimer,
|
||||||
],
|
],
|
||||||
);
|
);
|
||||||
};
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Utility to optimistically delete entries from client cache
|
* Utility to optimistically delete entries from client cache
|
||||||
|
|||||||
@@ -40,6 +40,15 @@ 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
|
||||||
@@ -47,6 +56,21 @@ 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', () => {
|
||||||
|
const location = resolvePath('/preset/demopage');
|
||||||
|
expect(getRouteFromPreset(location, presets)).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
it('returns null if the current location is the exact match of an unwrapped alias', () => {
|
it('returns null if the current location is the exact match of an unwrapped alias', () => {
|
||||||
// we make the current location be the alias
|
// we make the current location be the alias
|
||||||
const location = resolvePath('/timer?user=guest&alias=demopage');
|
const location = resolvePath('/timer?user=guest&alias=demopage');
|
||||||
@@ -81,6 +105,11 @@ 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', () => {
|
||||||
|
|||||||
@@ -3,9 +3,7 @@ import {
|
|||||||
Log,
|
Log,
|
||||||
MaybeNumber,
|
MaybeNumber,
|
||||||
MessageTag,
|
MessageTag,
|
||||||
ProjectRundownsList,
|
|
||||||
RefetchKey,
|
RefetchKey,
|
||||||
Rundown,
|
|
||||||
RuntimeStore,
|
RuntimeStore,
|
||||||
WsPacketToClient,
|
WsPacketToClient,
|
||||||
WsPacketToServer,
|
WsPacketToServer,
|
||||||
@@ -16,16 +14,17 @@ import {
|
|||||||
APP_SETTINGS,
|
APP_SETTINGS,
|
||||||
CLIENT_LIST,
|
CLIENT_LIST,
|
||||||
CSS_OVERRIDE,
|
CSS_OVERRIDE,
|
||||||
|
CURRENT_RUNDOWN_QUERY_KEY,
|
||||||
CUSTOM_FIELDS,
|
CUSTOM_FIELDS,
|
||||||
PROJECT_DATA,
|
PROJECT_DATA,
|
||||||
CURRENT_RUNDOWN_QUERY_KEY,
|
|
||||||
PROJECT_RUNDOWNS,
|
|
||||||
REPORT,
|
REPORT,
|
||||||
|
RUNDOWN,
|
||||||
RUNTIME,
|
RUNTIME,
|
||||||
TRANSLATION,
|
TRANSLATION,
|
||||||
URL_PRESETS,
|
URL_PRESETS,
|
||||||
VIEW_SETTINGS,
|
VIEW_SETTINGS,
|
||||||
getRundownQueryKey,
|
getRundownQueryKey,
|
||||||
|
PROJECT_RUNDOWNS,
|
||||||
} from '../api/constants';
|
} from '../api/constants';
|
||||||
import { invalidateAllCaches } from '../api/utils';
|
import { invalidateAllCaches } from '../api/utils';
|
||||||
import { ontimeQueryClient } from '../queryClient';
|
import { ontimeQueryClient } from '../queryClient';
|
||||||
@@ -181,7 +180,7 @@ export const connectSocket = () => {
|
|||||||
}
|
}
|
||||||
case MessageTag.Refetch: {
|
case MessageTag.Refetch: {
|
||||||
// the refetch message signals that the rundown has changed in the server side
|
// the refetch message signals that the rundown has changed in the server side
|
||||||
const { target, revision } = payload;
|
const { target, revision, rundownId } = payload;
|
||||||
switch (target) {
|
switch (target) {
|
||||||
case RefetchKey.All:
|
case RefetchKey.All:
|
||||||
invalidateAllCaches();
|
invalidateAllCaches();
|
||||||
@@ -196,7 +195,7 @@ export const connectSocket = () => {
|
|||||||
ontimeQueryClient.invalidateQueries({ queryKey: REPORT });
|
ontimeQueryClient.invalidateQueries({ queryKey: REPORT });
|
||||||
break;
|
break;
|
||||||
case RefetchKey.Rundown: {
|
case RefetchKey.Rundown: {
|
||||||
maybeInvalidateRundownCache(revision);
|
maybeInvalidateRundownCache(revision, rundownId);
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
case RefetchKey.UrlPresets:
|
case RefetchKey.UrlPresets:
|
||||||
@@ -214,6 +213,9 @@ 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;
|
||||||
@@ -232,34 +234,30 @@ export const connectSocket = () => {
|
|||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
export function maybeInvalidateRundownCache(revision: MaybeNumber, rundownId?: string) {
|
||||||
* When we receive a refetch message for the rundown
|
if (!rundownId) {
|
||||||
* check which rundown needs to be invalidated
|
// we omit rundownId to signify invalidate all rundowns
|
||||||
*/
|
ontimeQueryClient.invalidateQueries({ queryKey: RUNDOWN });
|
||||||
export function maybeInvalidateRundownCache(revision: MaybeNumber) {
|
ontimeQueryClient.invalidateQueries({ queryKey: CURRENT_RUNDOWN_QUERY_KEY, exact: true });
|
||||||
const loadedRundownId: string | undefined = (ontimeQueryClient.getQueryData(PROJECT_RUNDOWNS) as ProjectRundownsList)
|
|
||||||
?.loaded;
|
|
||||||
|
|
||||||
const activeRundownQueryKey = loadedRundownId ? getRundownQueryKey(loadedRundownId) : CURRENT_RUNDOWN_QUERY_KEY;
|
|
||||||
const cachedRundown = ontimeQueryClient.getQueryData<Rundown>(activeRundownQueryKey);
|
|
||||||
if (revision === cachedRundown?.revision) {
|
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
ontimeQueryClient.invalidateQueries({ queryKey: activeRundownQueryKey, exact: true });
|
// skip if we dont recognise the ID the revision is lower
|
||||||
|
const queryKey = getRundownQueryKey(rundownId);
|
||||||
|
const cachedRundown = ontimeQueryClient.getQueryData<{ revision: number }>(queryKey);
|
||||||
|
|
||||||
if (loadedRundownId) {
|
if (revision === cachedRundown?.revision) {
|
||||||
// Keep bootstrap alias in sync with the ID-based cache
|
// we already have the latest change
|
||||||
ontimeQueryClient.invalidateQueries({ queryKey: CURRENT_RUNDOWN_QUERY_KEY, exact: true });
|
return;
|
||||||
} else {
|
|
||||||
// During bootstrap, loadedRundownId is not yet known.
|
|
||||||
// Invalidate any ID-based rundown caches that may have been seeded early.
|
|
||||||
ontimeQueryClient.invalidateQueries({
|
|
||||||
predicate: (query) => query.queryKey[0] === 'rundown' && query.queryKey[1] !== 'current',
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
ontimeQueryClient.invalidateQueries({ queryKey: CUSTOM_FIELDS });
|
ontimeQueryClient.invalidateQueries({ queryKey, exact: true });
|
||||||
|
|
||||||
|
// keep current alias in sync with the ID-based cache
|
||||||
|
const loadedRundownId = ontimeQueryClient.getQueryData<{ loaded: string }>(PROJECT_RUNDOWNS)?.loaded;
|
||||||
|
if (!loadedRundownId || loadedRundownId === rundownId) {
|
||||||
|
ontimeQueryClient.invalidateQueries({ queryKey: CURRENT_RUNDOWN_QUERY_KEY, exact: true });
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export function sendSocket<T extends MessageTag | ApiActionTag>(
|
export function sendSocket<T extends MessageTag | ApiActionTag>(
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import {
|
|||||||
MILLIS_PER_MINUTE,
|
MILLIS_PER_MINUTE,
|
||||||
MILLIS_PER_SECOND,
|
MILLIS_PER_SECOND,
|
||||||
formatFromMillis,
|
formatFromMillis,
|
||||||
|
getExpectedEnd,
|
||||||
getExpectedStart,
|
getExpectedStart,
|
||||||
} from 'ontime-utils';
|
} from 'ontime-utils';
|
||||||
|
|
||||||
@@ -172,13 +173,15 @@ 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;
|
||||||
@@ -186,9 +189,7 @@ export function getExpectedTimesFromExtendedEvent(
|
|||||||
return {
|
return {
|
||||||
expectedStart,
|
expectedStart,
|
||||||
timeToStart: expectedStart - state.clock,
|
timeToStart: expectedStart - state.clock,
|
||||||
expectedEnd: event.countToEnd
|
expectedEnd: getExpectedEnd(event, expectedStartState),
|
||||||
? Math.max(expectedStart + event.duration, plannedEnd)
|
|
||||||
: expectedStart + event.duration,
|
|
||||||
plannedEnd,
|
plannedEnd,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -204,7 +204,7 @@ function isPresettableView(view: string): view is OntimeViewPresettable {
|
|||||||
/**
|
/**
|
||||||
* Check if current location is a preset path
|
* Check if current location is a preset path
|
||||||
*/
|
*/
|
||||||
export function isPresetPath(location: Path): boolean {
|
function isPresetPath(location: Path): boolean {
|
||||||
const segments = location.pathname.split('/').filter(Boolean);
|
const firstSegment = location.pathname.split('/').find(Boolean);
|
||||||
return segments[0] === 'preset';
|
return firstSegment === 'preset';
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -53,10 +53,6 @@ ul {
|
|||||||
background-color: $red-400;
|
background-color: $red-400;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
&.split {
|
|
||||||
margin-top: 1rem;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
.secondary {
|
.secondary {
|
||||||
|
|||||||
@@ -42,16 +42,9 @@ interface PanelListItemProps {
|
|||||||
location?: string;
|
location?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
function PanelListItem(props: PanelListItemProps) {
|
function PanelListItem({ panel, isSelected, location }: PanelListItemProps) {
|
||||||
const { panel, isSelected, location } = props;
|
|
||||||
const { setLocation } = useAppSettingsNavigation();
|
const { setLocation } = useAppSettingsNavigation();
|
||||||
|
const classes = cx([style.primary, isSelected && style.active, panel.highlight && style.highlight]);
|
||||||
const classes = cx([
|
|
||||||
style.primary,
|
|
||||||
isSelected && style.active,
|
|
||||||
panel.split && style.split,
|
|
||||||
panel.highlight && style.highlight,
|
|
||||||
]);
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Fragment key={panel.id}>
|
<Fragment key={panel.id}>
|
||||||
|
|||||||
+3
-4
@@ -89,10 +89,9 @@ export default function AutomationSettingsForm({
|
|||||||
|
|
||||||
<Panel.Section>
|
<Panel.Section>
|
||||||
<Info>
|
<Info>
|
||||||
<p>Control Ontime and share its data with external systems in your workflow.</p>
|
<span>Control Ontime and share its data with external systems in your workflow.</span>
|
||||||
<p>- Automations allow Ontime to send its data on lifecycle triggers.</p>
|
<span>- Automations allow Ontime to send its data on lifecycle triggers.</span>
|
||||||
<p>- OSC Input tells Ontime to listen to messages on the specific port.</p>
|
<span>- OSC Input tells Ontime to listen to messages on the specific port.</span>
|
||||||
<br />
|
|
||||||
<ExternalLink href={oscApiDocsUrl}>See the docs</ExternalLink>
|
<ExternalLink href={oscApiDocsUrl}>See the docs</ExternalLink>
|
||||||
</Info>
|
</Info>
|
||||||
</Panel.Section>
|
</Panel.Section>
|
||||||
|
|||||||
@@ -57,11 +57,11 @@ export default function CustomFieldSettings() {
|
|||||||
<Panel.Divider />
|
<Panel.Divider />
|
||||||
<Panel.Section>
|
<Panel.Section>
|
||||||
<Info>
|
<Info>
|
||||||
Custom fields allow for additional information to be added to an event.
|
<span>Custom fields allow for additional information to be added to an event.</span>
|
||||||
<br />
|
<span>
|
||||||
<br />
|
To use custom fields as a data source in an{' '}
|
||||||
To use custom fields as a data source in an{' '}
|
<AppLink search='settings=automation__automations'>Automation</AppLink>, please note the generated key.
|
||||||
<AppLink search='settings=automation__automations'>Automation</AppLink>, please note the generated key.
|
</span>
|
||||||
<ExternalLink href={customFieldsDocsUrl}>See the docs</ExternalLink>
|
<ExternalLink href={customFieldsDocsUrl}>See the docs</ExternalLink>
|
||||||
</Info>
|
</Info>
|
||||||
</Panel.Section>
|
</Panel.Section>
|
||||||
|
|||||||
@@ -52,8 +52,9 @@ export default function CustomViews() {
|
|||||||
|
|
||||||
<Panel.Section>
|
<Panel.Section>
|
||||||
<Info>
|
<Info>
|
||||||
Upload one <strong>index.html</strong> per view to <strong>/external/<name>/</strong>.
|
<span>
|
||||||
<br />
|
Upload one <strong>index.html</strong> per view to <strong>/external/<name>/</strong>.
|
||||||
|
</span>
|
||||||
External imports are not allowed, include all assets inside the html file.
|
External imports are not allowed, include all assets inside the html file.
|
||||||
<ExternalLink href={customViewsDocs}>See the docs</ExternalLink>
|
<ExternalLink href={customViewsDocs}>See the docs</ExternalLink>
|
||||||
</Info>
|
</Info>
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ 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';
|
||||||
@@ -19,6 +20,7 @@ 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';
|
||||||
@@ -97,6 +99,8 @@ export default function ManageRundowns() {
|
|||||||
await downloadAsExcel(rundownId, title);
|
await downloadAsExcel(rundownId, title);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
const navigateToCuesheet = useDirectLinkToBackgroundEdit();
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
<Panel.Section>
|
<Panel.Section>
|
||||||
@@ -153,7 +157,7 @@ export default function ManageRundowns() {
|
|||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<DropdownMenu
|
<DropdownMenu
|
||||||
render={<IconButton variant='ghosted-white' />}
|
render={<IconButton variant='ghosted-white' data-testId='rundown_menu' />}
|
||||||
items={[
|
items={[
|
||||||
{
|
{
|
||||||
type: 'item',
|
type: 'item',
|
||||||
@@ -180,6 +184,12 @@ 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',
|
||||||
|
|||||||
+1
@@ -20,4 +20,5 @@
|
|||||||
border: 1px solid $gray-1100;
|
border: 1px solid $gray-1100;
|
||||||
border-radius: 3px;
|
border-radius: 3px;
|
||||||
overflow: hidden;
|
overflow: hidden;
|
||||||
|
height: 100%;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ export type SettingsOption = {
|
|||||||
id: string;
|
id: string;
|
||||||
label: string;
|
label: string;
|
||||||
secondary?: Readonly<SettingsOption[]>;
|
secondary?: Readonly<SettingsOption[]>;
|
||||||
split?: boolean;
|
|
||||||
highlight?: string;
|
highlight?: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -26,7 +25,6 @@ const staticOptions = [
|
|||||||
{
|
{
|
||||||
id: 'project',
|
id: 'project',
|
||||||
label: 'Project',
|
label: 'Project',
|
||||||
split: true,
|
|
||||||
secondary: [
|
secondary: [
|
||||||
{ id: 'project__create', label: 'Create...' },
|
{ id: 'project__create', label: 'Create...' },
|
||||||
{ id: 'project__list', label: 'Manage projects' },
|
{ id: 'project__list', label: 'Manage projects' },
|
||||||
@@ -46,7 +44,6 @@ const staticOptions = [
|
|||||||
{
|
{
|
||||||
id: 'automation',
|
id: 'automation',
|
||||||
label: 'Automation',
|
label: 'Automation',
|
||||||
split: true,
|
|
||||||
secondary: [
|
secondary: [
|
||||||
{ id: 'automation__settings', label: 'Automation settings' },
|
{ id: 'automation__settings', label: 'Automation settings' },
|
||||||
{ id: 'automation__automations', label: 'Manage automations' },
|
{ id: 'automation__automations', label: 'Manage automations' },
|
||||||
@@ -56,7 +53,6 @@ const staticOptions = [
|
|||||||
{
|
{
|
||||||
id: 'sharing',
|
id: 'sharing',
|
||||||
label: 'Sharing and reporting',
|
label: 'Sharing and reporting',
|
||||||
split: true,
|
|
||||||
secondary: [
|
secondary: [
|
||||||
{ id: 'sharing__presets', label: 'URL Presets' },
|
{ id: 'sharing__presets', label: 'URL Presets' },
|
||||||
{
|
{
|
||||||
@@ -69,7 +65,6 @@ const staticOptions = [
|
|||||||
{
|
{
|
||||||
id: 'network',
|
id: 'network',
|
||||||
label: 'Network',
|
label: 'Network',
|
||||||
split: true,
|
|
||||||
secondary: [
|
secondary: [
|
||||||
{
|
{
|
||||||
id: 'network__log',
|
id: 'network__log',
|
||||||
@@ -84,12 +79,10 @@ const staticOptions = [
|
|||||||
{
|
{
|
||||||
id: 'about',
|
id: 'about',
|
||||||
label: 'About',
|
label: 'About',
|
||||||
split: true,
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
id: 'shutdown',
|
id: 'shutdown',
|
||||||
label: 'Shutdown',
|
label: 'Shutdown',
|
||||||
split: true,
|
|
||||||
},
|
},
|
||||||
] as const;
|
] as const;
|
||||||
|
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ 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';
|
||||||
@@ -104,6 +105,8 @@ 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 ? (
|
||||||
@@ -112,7 +115,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 />}
|
{viewMode === RundownViewMode.Table && <EntryEditModal rundown={source.rundown} />}
|
||||||
<RenumberCuesDialog />
|
<RenumberCuesDialog />
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
import { OntimeEntry, isOntimeEvent, isOntimeGroup, isOntimeMilestone } from 'ontime-types';
|
import { OntimeEntry, Rundown, 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';
|
||||||
@@ -10,19 +9,18 @@ import style from './EntryEditor.module.scss';
|
|||||||
|
|
||||||
interface CuesheetEntryEditorProps {
|
interface CuesheetEntryEditorProps {
|
||||||
entryId: string;
|
entryId: string;
|
||||||
|
rundown: Rundown;
|
||||||
}
|
}
|
||||||
|
|
||||||
export default function CuesheetEntryEditor({ entryId }: CuesheetEntryEditorProps) {
|
export default function CuesheetEntryEditor({ entryId, rundown }: CuesheetEntryEditorProps) {
|
||||||
const { data } = useRundown();
|
|
||||||
|
|
||||||
const entry = useMemo<OntimeEntry | null>(() => {
|
const entry = useMemo<OntimeEntry | null>(() => {
|
||||||
if (data.order.length === 0) {
|
if (rundown.order.length === 0) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
const event = data.entries[entryId];
|
const event = rundown.entries[entryId];
|
||||||
return event ?? null;
|
return event ?? null;
|
||||||
}, [entryId, data.order, data.entries]);
|
}, [entryId, rundown.entries, rundown.order.length]);
|
||||||
|
|
||||||
if (isOntimeEvent(entry)) {
|
if (isOntimeEvent(entry)) {
|
||||||
return (
|
return (
|
||||||
|
|||||||
@@ -1,39 +0,0 @@
|
|||||||
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,7 +1,10 @@
|
|||||||
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';
|
||||||
@@ -13,6 +16,8 @@ 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(() => {
|
||||||
@@ -30,12 +35,14 @@ function RundownTable() {
|
|||||||
const isLoading = !customFields || customFieldStatus === 'pending';
|
const isLoading = !customFields || customFieldStatus === 'pending';
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<CuesheetDnd columns={columns} tableRoot='editor'>
|
<EntryActionsProvider actions={actions}>
|
||||||
{isLoading ? (
|
<CuesheetDnd columns={columns} tableRoot='editor'>
|
||||||
<EmptyPage text='Loading...' />
|
{isLoading ? (
|
||||||
) : (
|
<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 { CURRENT_RUNDOWN_QUERY_KEY, PROJECT_RUNDOWNS, getRundownQueryKey } from '../../common/api/constants';
|
import { 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,12 +137,9 @@ export const useEventSelection = create<EventSelectionStore>()((set, get) => ({
|
|||||||
}));
|
}));
|
||||||
|
|
||||||
function getLoadedRundownData() {
|
function getLoadedRundownData() {
|
||||||
const loadedRundownId = ontimeQueryClient.getQueryData<ProjectRundownsList>(PROJECT_RUNDOWNS)?.loaded;
|
const rundownId = ontimeQueryClient.getQueryData<ProjectRundownsList>(PROJECT_RUNDOWNS)?.loaded;
|
||||||
if (loadedRundownId) {
|
if (!rundownId) return undefined;
|
||||||
return ontimeQueryClient.getQueryData<Rundown>(getRundownQueryKey(loadedRundownId));
|
return ontimeQueryClient.getQueryData<Rundown>(getRundownQueryKey(rundownId));
|
||||||
}
|
|
||||||
|
|
||||||
return ontimeQueryClient.getQueryData<Rundown>(CURRENT_RUNDOWN_QUERY_KEY);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export function getSelectionMode(event: MouseEvent): SelectionMode {
|
export function getSelectionMode(event: MouseEvent): SelectionMode {
|
||||||
|
|||||||
@@ -82,5 +82,5 @@ export const initializeSentry = () => {
|
|||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
return Sentry.withSentryReactRouterV6Routing(Routes);
|
return Sentry.withSentryReactRouterV7Routing(Routes);
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -14,3 +14,7 @@
|
|||||||
'table';
|
'table';
|
||||||
color: $ui-white;
|
color: $ui-white;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.rundownSelect {
|
||||||
|
min-width: min(20rem, calc(100vw - 6rem));
|
||||||
|
}
|
||||||
|
|||||||
@@ -4,28 +4,34 @@ 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 { useEntryActions } from '../../common/hooks/useEntryAction';
|
import { useScopedRundown } from '../../common/hooks-query/useScopedRundown';
|
||||||
|
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 entryActions = useEntryActions();
|
const { selectedRundownId, loadedRundownId, setSelectedRundownId, projectRundowns } = useCuesheetRundownSelection();
|
||||||
|
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={entryActions}>
|
<EntryActionsProvider actions={actions}>
|
||||||
<NavigationMenu isOpen={isMenuOpen} onClose={menuHandler.close} />
|
<NavigationMenu isOpen={isMenuOpen} onClose={menuHandler.close} />
|
||||||
<EntryEditModal />
|
<EntryEditModal rundown={source.rundown} />
|
||||||
<div className={styles.tableWrapper} data-testid='cuesheet'>
|
<div className={styles.tableWrapper} data-testid='cuesheet'>
|
||||||
<CuesheetOverview>
|
<CuesheetOverview>
|
||||||
{!isLocked && (
|
{!isLocked && (
|
||||||
@@ -35,7 +41,13 @@ 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,18 +1,40 @@
|
|||||||
|
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({
|
||||||
const { data: customFields, status: customFieldStatus } = useCustomFields();
|
source,
|
||||||
|
selectedRundownId,
|
||||||
|
setSelectedRundownId,
|
||||||
|
loadedRundownId,
|
||||||
|
projectRundowns,
|
||||||
|
}: CuesheetTableWrapperProps) {
|
||||||
const preset = use(PresetContext);
|
const preset = use(PresetContext);
|
||||||
const { cuesheetMode, setCuesheetMode } = useApplyCuesheetPolicy(preset);
|
const isCurrentRundown = source.rundownId !== null && source.rundownId === loadedRundownId;
|
||||||
|
const { cuesheetMode, setCuesheetMode } = useApplyCuesheetPolicy(preset, { canRunMode: isCurrentRundown });
|
||||||
|
const { data: customFields, status: customFieldStatus } = useCustomFields();
|
||||||
|
|
||||||
const columns = useMemo(
|
const columns = useMemo(
|
||||||
() => makeCuesheetColumns(customFields, cuesheetMode, preset),
|
() => makeCuesheetColumns(customFields, cuesheetMode, preset),
|
||||||
@@ -28,11 +50,66 @@ 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>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,25 @@
|
|||||||
|
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);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
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,11 +1,16 @@
|
|||||||
|
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() {
|
function EntryEditModal({ rundown }: EntryEditModalProps) {
|
||||||
const entryId = useEditModal((state) => state.selectedEntryId);
|
const entryId = useEditModal((state) => state.selectedEntryId);
|
||||||
const closeModal = useEditModal((state) => state.clearSelection);
|
const closeModal = useEditModal((state) => state.clearSelection);
|
||||||
|
|
||||||
@@ -19,7 +24,7 @@ function EntryEditModal() {
|
|||||||
onClose={closeModal}
|
onClose={closeModal}
|
||||||
title='Edit entry'
|
title='Edit entry'
|
||||||
showCloseButton
|
showCloseButton
|
||||||
bodyElements={<CuesheetEntryEditor entryId={entryId} />}
|
bodyElements={<CuesheetEntryEditor entryId={entryId} rundown={rundown} />}
|
||||||
/>
|
/>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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, TimeField, isOntimeDelay, isOntimeGroup, isOntimeMilestone } from 'ontime-types';
|
import { OntimeEntry, SupportedEntry, TimeField, isOntimeDelay, isOntimeGroup, isOntimeMilestone } from 'ontime-types';
|
||||||
import { ComponentProps, memo, useCallback, useEffect, useMemo, useRef } from 'react';
|
import { ComponentProps, ReactNode, memo, useCallback, useEffect, useMemo, useRef } from 'react';
|
||||||
import {
|
import {
|
||||||
ContextProp,
|
ContextProp,
|
||||||
ItemProps,
|
ItemProps,
|
||||||
@@ -14,21 +14,20 @@ 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 { useFlatRundownWithMetadata } from '../../../common/hooks-query/useRundown';
|
import type { RundownSource } from '../../../common/hooks-query/useScopedRundown';
|
||||||
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 CuesheetTableSettings from './cuesheet-table-settings/CuesheetTableSettings';
|
import CuesheetTableHeaderToolbar from './cuesheet-table-settings/CuesheetTableHeaderToolbar';
|
||||||
import { useColumnOrder, useColumnSizes, useColumnVisibility } from './useColumnManager';
|
import { useColumnOrder, useColumnSizes, useColumnVisibility } from './useColumnManager';
|
||||||
|
|
||||||
import style from './CuesheetTable.module.scss';
|
import style from './CuesheetTable.module.scss';
|
||||||
@@ -36,30 +35,41 @@ 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({ columns, cuesheetMode, tableRoot, setCuesheetMode }: CuesheetTableProps) {
|
export default function CuesheetTable({
|
||||||
const { data, status } = useFlatRundownWithMetadata();
|
columns,
|
||||||
const { updateEntry, updateTimer } = useEntryActionsContext();
|
cuesheetMode,
|
||||||
|
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 showDelayedTimes = useOptions((state) => state.showDelayedTimes);
|
const optionsStore = useOptions();
|
||||||
const hideTableSeconds = useOptions((state) => state.hideTableSeconds);
|
const { showDelayedTimes, hideTableSeconds, hideIndexColumn } = optionsStore;
|
||||||
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);
|
||||||
|
|
||||||
@@ -70,7 +80,7 @@ export default function CuesheetTable({ columns, cuesheetMode, tableRoot, setCue
|
|||||||
() => ({
|
() => ({
|
||||||
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 = data[rowIndex];
|
const event = flatRundown[rowIndex];
|
||||||
|
|
||||||
if (!event) {
|
if (!event) {
|
||||||
return;
|
return;
|
||||||
@@ -101,7 +111,7 @@ export default function CuesheetTable({ columns, cuesheetMode, tableRoot, setCue
|
|||||||
hideIndexColumn,
|
hideIndexColumn,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
[cuesheetMode, data, hideIndexColumn, hideTableSeconds, showDelayedTimes, updateEntry, updateTimer],
|
[cuesheetMode, flatRundown, hideIndexColumn, hideTableSeconds, showDelayedTimes, updateEntry, updateTimer],
|
||||||
);
|
);
|
||||||
|
|
||||||
const { columnOrder, resetColumnOrder } = useColumnOrder(columns, tableRoot);
|
const { columnOrder, resetColumnOrder } = useColumnOrder(columns, tableRoot);
|
||||||
@@ -109,7 +119,7 @@ export default function CuesheetTable({ columns, cuesheetMode, tableRoot, setCue
|
|||||||
const { columnVisibility, setColumnVisibility } = useColumnVisibility(tableRoot);
|
const { columnVisibility, setColumnVisibility } = useColumnVisibility(tableRoot);
|
||||||
|
|
||||||
const table = useReactTable({
|
const table = useReactTable({
|
||||||
data,
|
data: flatRundown,
|
||||||
columns,
|
columns,
|
||||||
columnResizeMode: 'onChange',
|
columnResizeMode: 'onChange',
|
||||||
state: {
|
state: {
|
||||||
@@ -137,13 +147,13 @@ export default function CuesheetTable({ columns, cuesheetMode, tableRoot, setCue
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
const eventIndex = data.findIndex((event) => event.id === selectedEventId);
|
const eventIndex = flatRundown.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, data, selectedEventId]);
|
}, [cuesheetMode, flatRundown, selectedEventId]);
|
||||||
|
|
||||||
// Provide an imperative scroll handler for explicit jumps (finder/keyboard)
|
// Provide an imperative scroll handler for explicit jumps (finder/keyboard)
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
@@ -152,7 +162,7 @@ export default function CuesheetTable({ columns, cuesheetMode, tableRoot, setCue
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
const eventIndex = data.findIndex((event) => event.id === entryId);
|
const eventIndex = flatRundown.findIndex((event) => event.id === entryId);
|
||||||
if (eventIndex === -1) {
|
if (eventIndex === -1) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
@@ -165,7 +175,7 @@ export default function CuesheetTable({ columns, cuesheetMode, tableRoot, setCue
|
|||||||
return () => {
|
return () => {
|
||||||
setScrollHandler(null);
|
setScrollHandler(null);
|
||||||
};
|
};
|
||||||
}, [data, setScrollHandler]);
|
}, [flatRundown, setScrollHandler]);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* To improve performance on resizing, we memoise the column sizes
|
* To improve performance on resizing, we memoise the column sizes
|
||||||
@@ -194,8 +204,9 @@ export default function CuesheetTable({ columns, cuesheetMode, tableRoot, setCue
|
|||||||
listeners,
|
listeners,
|
||||||
rows,
|
rows,
|
||||||
table,
|
table,
|
||||||
|
handleAddNew: canCreateEntries ? (type: SupportedEntry) => addEntry({ type }) : undefined,
|
||||||
}),
|
}),
|
||||||
[columnSizeVars, cursor, listeners, rows, table],
|
[columnSizeVars, cursor, listeners, rows, table, addEntry, canCreateEntries],
|
||||||
);
|
);
|
||||||
|
|
||||||
const computeItemKey = useCallback((_: number, item: ExtendedEntry) => item.id, []);
|
const computeItemKey = useCallback((_: number, item: ExtendedEntry) => item.id, []);
|
||||||
@@ -217,7 +228,7 @@ export default function CuesheetTable({ columns, cuesheetMode, tableRoot, setCue
|
|||||||
});
|
});
|
||||||
}, [cuesheetMode, hideIndexColumn, table]);
|
}, [cuesheetMode, hideIndexColumn, table]);
|
||||||
|
|
||||||
const isLoading = !data || status === 'pending';
|
const isLoading = !flatRundown || status === 'pending';
|
||||||
|
|
||||||
if (isLoading) {
|
if (isLoading) {
|
||||||
return <EmptyPage text='Loading...' />;
|
return <EmptyPage text='Loading...' />;
|
||||||
@@ -225,26 +236,27 @@ export default function CuesheetTable({ columns, cuesheetMode, tableRoot, setCue
|
|||||||
|
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
{tableRoot === 'editor' ? (
|
<CuesheetTableHeaderToolbar
|
||||||
<EditorTableSettings
|
columns={allLeafColumns}
|
||||||
columns={allLeafColumns}
|
optionsStore={optionsStore}
|
||||||
handleResetResizing={resetColumnResizing}
|
handleResetResizing={resetColumnResizing}
|
||||||
handleResetReordering={resetColumnOrder}
|
handleResetReordering={resetColumnOrder}
|
||||||
handleClearToggles={setAllVisible}
|
handleClearToggles={setAllVisible}
|
||||||
/>
|
insertElement={insertElement}
|
||||||
) : (
|
modeControls={
|
||||||
<CuesheetTableSettings
|
tableRoot === 'cuesheet'
|
||||||
columns={allLeafColumns}
|
? {
|
||||||
cuesheetMode={cuesheetMode}
|
cuesheetMode,
|
||||||
setCuesheetMode={setCuesheetMode}
|
setCuesheetMode,
|
||||||
handleResetResizing={resetColumnResizing}
|
isCurrentRundown,
|
||||||
handleResetReordering={resetColumnOrder}
|
}
|
||||||
handleClearToggles={setAllVisible}
|
: undefined
|
||||||
/>
|
}
|
||||||
)}
|
showShare={tableRoot === 'cuesheet'}
|
||||||
|
/>
|
||||||
<TableVirtuoso
|
<TableVirtuoso
|
||||||
ref={virtuosoRef}
|
ref={virtuosoRef}
|
||||||
data={data}
|
data={flatRundown}
|
||||||
context={virtuosoContext}
|
context={virtuosoContext}
|
||||||
style={tableRoot === 'editor' ? { paddingLeft: '1rem' } : undefined}
|
style={tableRoot === 'editor' ? { paddingLeft: '1rem' } : undefined}
|
||||||
computeItemKey={computeItemKey}
|
computeItemKey={computeItemKey}
|
||||||
@@ -264,10 +276,13 @@ 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({
|
||||||
return <EmptyTableBody text='No data in rundown' />;
|
context,
|
||||||
|
}: TableProps & ContextProp<CuesheetVirtuosoContext>) {
|
||||||
|
return <EmptyTableBody handleAddNew={context.handleAddNew} />;
|
||||||
});
|
});
|
||||||
|
|
||||||
const CuesheetTableElement = memo(function CuesheetTableElement({
|
const CuesheetTableElement = memo(function CuesheetTableElement({
|
||||||
|
|||||||
+6
@@ -49,6 +49,10 @@ 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) => {
|
||||||
@@ -95,8 +99,10 @@ 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
|
||||||
|
|||||||
+4
-3
@@ -30,15 +30,16 @@ 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) => {
|
||||||
|
|||||||
+17
-15
@@ -1,7 +1,7 @@
|
|||||||
import { Table, flexRender } from '@tanstack/react-table';
|
import { Table, flexRender } from '@tanstack/react-table';
|
||||||
import { EntryId, OntimeEntry, RGBColour, SupportedEntry } from 'ontime-types';
|
import { EntryId, OntimeEntry, RGBColour, SupportedEntry } from 'ontime-types';
|
||||||
import { colourToHex, cssOrHexToColour } from 'ontime-utils';
|
import { colourToHex, cssOrHexToColour } from 'ontime-utils';
|
||||||
import { CSSProperties, useMemo } from 'react';
|
import { CSSProperties, memo, useMemo } from 'react';
|
||||||
import { IoEllipsisHorizontal } from 'react-icons/io5';
|
import { IoEllipsisHorizontal } from 'react-icons/io5';
|
||||||
|
|
||||||
import IconButton from '../../../../common/components/buttons/IconButton';
|
import IconButton from '../../../../common/components/buttons/IconButton';
|
||||||
@@ -30,7 +30,8 @@ interface EventRowProps {
|
|||||||
hasCursor?: boolean;
|
hasCursor?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export default function EventRow({
|
export default memo(EventRow);
|
||||||
|
function EventRow({
|
||||||
rowId,
|
rowId,
|
||||||
id,
|
id,
|
||||||
eventIndex,
|
eventIndex,
|
||||||
@@ -55,24 +56,25 @@ export default function EventRow({
|
|||||||
|
|
||||||
const openMenu = useCuesheetTableMenu((store) => store.openMenu);
|
const openMenu = useCuesheetTableMenu((store) => store.openMenu);
|
||||||
|
|
||||||
const { color, backgroundColor } = getAccessibleColour(colour);
|
const { rowBgColour, backgroundColor, mutedText } = useMemo(() => {
|
||||||
const tmpColour = cssOrHexToColour(color) as RGBColour; // we know this to be a correct colour
|
const accessible = getAccessibleColour(colour);
|
||||||
const mutedText = colourToHex({ ...tmpColour, alpha: tmpColour.alpha * 0.8 });
|
const tmpColour = cssOrHexToColour(accessible.color) as RGBColour;
|
||||||
|
|
||||||
const rowBgColour: string | undefined = useMemo(() => {
|
let rowBgColour: string | undefined;
|
||||||
if (isLoaded) {
|
if (isLoaded) {
|
||||||
return '#087A27'; // $active-green
|
rowBgColour = '#087A27'; // $active-green
|
||||||
} else if (colour) {
|
} else if (colour) {
|
||||||
// the colour is user defined and might be invalid
|
const accessibleBg = cssOrHexToColour(accessible.backgroundColor);
|
||||||
const accessibleBackgroundColor = cssOrHexToColour(getAccessibleColour(colour).backgroundColor);
|
if (accessibleBg !== null) {
|
||||||
if (accessibleBackgroundColor !== null) {
|
rowBgColour = colourToHex({ ...accessibleBg, alpha: accessibleBg.alpha * 0.25 });
|
||||||
return colourToHex({
|
|
||||||
...accessibleBackgroundColor,
|
|
||||||
alpha: accessibleBackgroundColor.alpha * 0.25,
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return;
|
|
||||||
|
return {
|
||||||
|
rowBgColour,
|
||||||
|
backgroundColor: accessible.backgroundColor,
|
||||||
|
mutedText: colourToHex({ ...tmpColour, alpha: tmpColour.alpha * 0.8 }),
|
||||||
|
};
|
||||||
}, [colour, isLoaded]);
|
}, [colour, isLoaded]);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import { Table, flexRender } from '@tanstack/react-table';
|
import { Table, flexRender } from '@tanstack/react-table';
|
||||||
import { EntryId, SupportedEntry } from 'ontime-types';
|
import { EntryId, SupportedEntry } from 'ontime-types';
|
||||||
import { CSSProperties } from 'react';
|
import { CSSProperties, memo } from 'react';
|
||||||
import { IoEllipsisHorizontal } from 'react-icons/io5';
|
import { IoEllipsisHorizontal } from 'react-icons/io5';
|
||||||
|
|
||||||
import IconButton from '../../../../common/components/buttons/IconButton';
|
import IconButton from '../../../../common/components/buttons/IconButton';
|
||||||
@@ -20,7 +20,8 @@ interface GroupRowProps {
|
|||||||
hasCursor?: boolean;
|
hasCursor?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export default function GroupRow({
|
export default memo(GroupRow);
|
||||||
|
function GroupRow({
|
||||||
groupId,
|
groupId,
|
||||||
colour,
|
colour,
|
||||||
rowId,
|
rowId,
|
||||||
|
|||||||
+9
-13
@@ -1,7 +1,7 @@
|
|||||||
import { Table, flexRender } from '@tanstack/react-table';
|
import { Table, flexRender } from '@tanstack/react-table';
|
||||||
import { EntryId, SupportedEntry } from 'ontime-types';
|
import { EntryId, SupportedEntry } from 'ontime-types';
|
||||||
import { colourToHex, cssOrHexToColour } from 'ontime-utils';
|
import { colourToHex, cssOrHexToColour } from 'ontime-utils';
|
||||||
import { CSSProperties } from 'react';
|
import { CSSProperties, memo, useMemo } from 'react';
|
||||||
import { IoEllipsisHorizontal } from 'react-icons/io5';
|
import { IoEllipsisHorizontal } from 'react-icons/io5';
|
||||||
|
|
||||||
import IconButton from '../../../../common/components/buttons/IconButton';
|
import IconButton from '../../../../common/components/buttons/IconButton';
|
||||||
@@ -25,7 +25,8 @@ interface MilestoneRowProps {
|
|||||||
hasCursor?: boolean;
|
hasCursor?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export default function MilestoneRow({
|
export default memo(MilestoneRow);
|
||||||
|
function MilestoneRow({
|
||||||
entryId,
|
entryId,
|
||||||
isPast,
|
isPast,
|
||||||
parentBgColour,
|
parentBgColour,
|
||||||
@@ -45,17 +46,12 @@ export default function MilestoneRow({
|
|||||||
|
|
||||||
const openMenu = useCuesheetTableMenu((store) => store.openMenu);
|
const openMenu = useCuesheetTableMenu((store) => store.openMenu);
|
||||||
|
|
||||||
let rowBgColour: string | undefined;
|
const rowBgColour = useMemo(() => {
|
||||||
if (colour) {
|
if (!colour) return undefined;
|
||||||
// the colour is user defined and might be invalid
|
const accessibleBg = cssOrHexToColour(getAccessibleColour(colour).backgroundColor);
|
||||||
const accessibleBackgroundColor = cssOrHexToColour(getAccessibleColour(colour).backgroundColor);
|
if (accessibleBg === null) return undefined;
|
||||||
if (accessibleBackgroundColor !== null) {
|
return colourToHex({ ...accessibleBg, alpha: accessibleBg.alpha * 0.25 });
|
||||||
rowBgColour = colourToHex({
|
}, [colour]);
|
||||||
...accessibleBackgroundColor,
|
|
||||||
alpha: accessibleBackgroundColor.alpha * 0.25,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<tr
|
<tr
|
||||||
|
|||||||
+14
-1
@@ -8,13 +8,24 @@ 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);
|
||||||
@@ -25,7 +36,9 @@ 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,6 +50,10 @@ 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) => {
|
||||||
@@ -96,8 +100,10 @@ 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
|
||||||
|
|||||||
+72
-48
@@ -11,78 +11,92 @@ 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';
|
||||||
|
|
||||||
interface CuesheetTableSettingsProps {
|
type TableHeaderOptionsStore = {
|
||||||
columns: Column<ExtendedEntry, unknown>[];
|
hideTableSeconds: boolean;
|
||||||
|
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;
|
||||||
handleResetResizing: () => void;
|
isCurrentRundown?: boolean;
|
||||||
handleResetReordering: () => void;
|
};
|
||||||
handleClearToggles: () => void;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ViewSettingsProps {
|
interface CuesheetTableHeaderToolbarProps {
|
||||||
optionsStore: CuesheetOptions;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ColumnSettingsProps {
|
|
||||||
columns: Column<ExtendedEntry, unknown>[];
|
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 CuesheetTableSettings({
|
export default function CuesheetTableHeaderToolbar({
|
||||||
columns,
|
columns,
|
||||||
cuesheetMode,
|
optionsStore,
|
||||||
setCuesheetMode,
|
|
||||||
handleResetResizing,
|
handleResetResizing,
|
||||||
handleResetReordering,
|
handleResetReordering,
|
||||||
handleClearToggles,
|
handleClearToggles,
|
||||||
}: CuesheetTableSettingsProps) {
|
insertElement,
|
||||||
|
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) return;
|
if (!newValue || !modeControls) return;
|
||||||
setCuesheetMode(newValue);
|
modeControls.setCuesheetMode(newValue);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
const isBackground = !(modeControls?.isCurrentRundown ?? true);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Toolbar.Root className={style.tableSettings}>
|
<Toolbar.Root className={style.tableSettings} data-background-rundown={isBackground}>
|
||||||
<ViewSettings optionsStore={options} />
|
<ViewSettings optionsStore={optionsStore} />
|
||||||
<ColumnSettings
|
<ColumnSettings
|
||||||
columns={columns}
|
columns={columns}
|
||||||
handleResetResizing={handleResetResizing}
|
handleResetResizing={handleResetResizing}
|
||||||
handleResetReordering={handleResetReordering}
|
handleResetReordering={handleResetReordering}
|
||||||
handleClearToggles={handleClearToggles}
|
handleClearToggles={handleClearToggles}
|
||||||
/>
|
/>
|
||||||
{canChangeMode && (
|
{modeControls && canChangeMode && (
|
||||||
<ToggleGroup
|
<div className={style.apart}>
|
||||||
value={[cuesheetMode]}
|
{insertElement}
|
||||||
onValueChange={toggleCuesheetMode}
|
<ToggleGroup
|
||||||
className={cx([style.group, style.apart])}
|
value={[modeControls.cuesheetMode]}
|
||||||
>
|
onValueChange={toggleCuesheetMode}
|
||||||
<Toolbar.Button render={<Toggle />} value={AppMode.Run} className={style.radioButton}>
|
className={style.group}
|
||||||
Run
|
disabled={!modeControls.isCurrentRundown}
|
||||||
</Toolbar.Button>
|
>
|
||||||
<Toolbar.Button render={<Toggle />} value={AppMode.Edit} className={style.radioButton}>
|
<Toolbar.Button render={<Toggle />} value={AppMode.Run} className={style.radioButton}>
|
||||||
Edit
|
Run
|
||||||
</Toolbar.Button>
|
</Toolbar.Button>
|
||||||
</ToggleGroup>
|
<Toolbar.Button render={<Toggle />} value={AppMode.Edit} className={style.radioButton}>
|
||||||
|
Edit
|
||||||
|
</Toolbar.Button>
|
||||||
|
</ToggleGroup>
|
||||||
|
</div>
|
||||||
)}
|
)}
|
||||||
|
|
||||||
{canShare && (
|
{showShare && canShare && (
|
||||||
<>
|
<>
|
||||||
<Editor.Separator orientation='vertical' />
|
<Editor.Separator orientation='vertical' />
|
||||||
<CuesheetShareModal />
|
<CuesheetShareModal />
|
||||||
@@ -92,9 +106,18 @@ export default function CuesheetTableSettings({
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
export function ViewSettings({ optionsStore }: ViewSettingsProps) {
|
interface ViewSettingsProps {
|
||||||
const options = optionsStore;
|
optionsStore: TableHeaderOptionsStore;
|
||||||
|
}
|
||||||
|
|
||||||
|
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
|
||||||
@@ -115,15 +138,15 @@ export 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={options.hideTableSeconds}
|
defaultChecked={optionsStore.hideTableSeconds}
|
||||||
onCheckedChange={(checked) => options.setOption('hideTableSeconds', checked)}
|
onCheckedChange={(checked) => optionsStore.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={options.hideIndexColumn}
|
defaultChecked={optionsStore.hideIndexColumn}
|
||||||
onCheckedChange={(checked) => options.setOption('hideIndexColumn', checked)}
|
onCheckedChange={(checked) => optionsStore.setOption('hideIndexColumn', checked)}
|
||||||
/>
|
/>
|
||||||
Hide index column
|
Hide index column
|
||||||
</Editor.Label>
|
</Editor.Label>
|
||||||
@@ -133,15 +156,15 @@ export 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={options.showDelayedTimes}
|
defaultChecked={optionsStore.showDelayedTimes}
|
||||||
onCheckedChange={(checked) => options.setOption('showDelayedTimes', checked)}
|
onCheckedChange={(checked) => optionsStore.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={options.hideDelays}
|
defaultChecked={optionsStore.hideDelays}
|
||||||
onCheckedChange={(checked) => options.setOption('hideDelays', checked)}
|
onCheckedChange={(checked) => optionsStore.setOption('hideDelays', checked)}
|
||||||
/>
|
/>
|
||||||
Hide delay entries
|
Hide delay entries
|
||||||
</Editor.Label>
|
</Editor.Label>
|
||||||
@@ -151,7 +174,7 @@ export function ViewSettings({ optionsStore }: ViewSettingsProps) {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
export function ColumnSettings({
|
function ColumnSettings({
|
||||||
columns,
|
columns,
|
||||||
handleResetResizing,
|
handleResetResizing,
|
||||||
handleResetReordering,
|
handleResetReordering,
|
||||||
@@ -177,6 +200,7 @@ export 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} />
|
||||||
+28
-2
@@ -8,6 +8,24 @@
|
|||||||
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 {
|
||||||
@@ -43,6 +61,9 @@
|
|||||||
|
|
||||||
.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 */
|
||||||
@@ -70,12 +91,17 @@
|
|||||||
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(:disabled):not(:active) {
|
&:hover:not([data-disabled]):not(:active) {
|
||||||
background: $gray-1000;
|
background: $gray-1000;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -87,7 +113,7 @@
|
|||||||
background: $blue-700;
|
background: $blue-700;
|
||||||
color: $ui-white;
|
color: $ui-white;
|
||||||
|
|
||||||
&:hover:not(:disabled):not(:active) {
|
&:hover:not([data-disabled]):not(:active) {
|
||||||
background: $blue-600;
|
background: $blue-600;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,12 +5,33 @@ 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(preset: URLPreset | undefined): {
|
export function useApplyCuesheetPolicy(
|
||||||
|
preset: URLPreset | undefined,
|
||||||
|
{ canRunMode }: CuesheetPolicyOptions,
|
||||||
|
): {
|
||||||
cuesheetMode: AppMode;
|
cuesheetMode: AppMode;
|
||||||
setCuesheetMode: (mode: AppMode) => void;
|
setCuesheetMode: (mode: AppMode) => void;
|
||||||
} {
|
} {
|
||||||
@@ -26,16 +47,14 @@ export function useApplyCuesheetPolicy(preset: URLPreset | undefined): {
|
|||||||
defaultValue: preset ? AppMode.Run : AppMode.Edit,
|
defaultValue: preset ? AppMode.Run : AppMode.Edit,
|
||||||
});
|
});
|
||||||
|
|
||||||
const cuesheetMode = permissions.canChangeMode ? storedCuesheetMode : AppMode.Run;
|
const cuesheetMode = getEffectiveCuesheetMode(permissions, storedCuesheetMode, { canRunMode });
|
||||||
|
|
||||||
const setCuesheetMode = useCallback(
|
const setCuesheetMode = useCallback(
|
||||||
(mode: AppMode) => {
|
(mode: AppMode) => {
|
||||||
if (!permissions.canChangeMode) {
|
if (!permissions.canChangeMode || !canRunMode) return;
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
setStoredCuesheetMode(mode);
|
setStoredCuesheetMode(mode);
|
||||||
},
|
},
|
||||||
[permissions.canChangeMode, setStoredCuesheetMode],
|
[canRunMode, 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.
|
||||||
|
|||||||
@@ -0,0 +1,65 @@
|
|||||||
|
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],
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -45,6 +45,9 @@ $studio-idle: $red-1300;
|
|||||||
top: 0;
|
top: 0;
|
||||||
top: 50%;
|
top: 50%;
|
||||||
left: 50%;
|
left: 50%;
|
||||||
|
|
||||||
|
margin-top: -0.5rem;
|
||||||
|
margin-left: -0.5rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
.tick--active {
|
.tick--active {
|
||||||
|
|||||||
@@ -87,7 +87,7 @@ export default defineConfig({
|
|||||||
},
|
},
|
||||||
test: {
|
test: {
|
||||||
globals: true,
|
globals: true,
|
||||||
environment: 'jsdom',
|
dom: true,
|
||||||
},
|
},
|
||||||
build: {
|
build: {
|
||||||
outDir: './build',
|
outDir: './build',
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "ontime-electron",
|
"name": "ontime-electron",
|
||||||
"version": "4.8.0",
|
"version": "4.9.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,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@getontime/resolver",
|
"name": "@getontime/resolver",
|
||||||
"version": "4.8.0",
|
"version": "4.9.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",
|
||||||
|
|||||||
@@ -2,21 +2,21 @@
|
|||||||
"name": "ontime-server",
|
"name": "ontime-server",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "src/index.ts",
|
"main": "src/index.ts",
|
||||||
"version": "4.8.0",
|
"version": "4.9.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.5",
|
"cors": "2.8.6",
|
||||||
"dotenv": "^16.0.1",
|
"dotenv": "^16.0.1",
|
||||||
"express": "5.1.0",
|
"express": "5.2.1",
|
||||||
"express-static-gzip": "3.0.0",
|
"express-static-gzip": "3.0.1",
|
||||||
"express-validator": "7.2.1",
|
"express-validator": "7.3.2",
|
||||||
"fast-equals": "^5.0.1",
|
"fast-equals": "^6.0.0",
|
||||||
"google-auth-library": "^9.4.2",
|
"google-auth-library": "^9.4.2",
|
||||||
"lowdb": "^7.0.1",
|
"lowdb": "^7.0.1",
|
||||||
"multer": "2.1.0",
|
"multer": "2.2.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,17 +24,15 @@
|
|||||||
"xlsx": "^0.18.5"
|
"xlsx": "^0.18.5"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/cookie-parser": "1.4.9",
|
"@types/cookie-parser": "1.4.10",
|
||||||
"@types/cors": "2.8.19",
|
"@types/cors": "2.8.19",
|
||||||
"@types/express": "5.0.3",
|
"@types/express": "5.0.6",
|
||||||
"@types/multer": "2.1.0",
|
"@types/multer": "2.1.0",
|
||||||
"@types/node": "catalog:",
|
"@types/node": "catalog:",
|
||||||
"@types/websocket": "^1.0.5",
|
|
||||||
"@types/ws": "^8.5.10",
|
"@types/ws": "^8.5.10",
|
||||||
"esbuild": "^0.24.0",
|
"esbuild": "^0.24.0",
|
||||||
"ontime-types": "workspace:*",
|
"ontime-types": "workspace:*",
|
||||||
"server-timing": "^3.3.3",
|
"server-timing": "^3.3.3",
|
||||||
"shx": "^0.3.4",
|
|
||||||
"ts-essentials": "catalog:",
|
"ts-essentials": "catalog:",
|
||||||
"tsx": "^4.19.2",
|
"tsx": "^4.19.2",
|
||||||
"typescript": "catalog:",
|
"typescript": "catalog:",
|
||||||
|
|||||||
@@ -262,6 +262,6 @@ export const socket = new SocketServer();
|
|||||||
/**
|
/**
|
||||||
* Utility function to notify clients that the REST data is stale
|
* Utility function to notify clients that the REST data is stale
|
||||||
*/
|
*/
|
||||||
export function sendRefetch(target: RefetchKey, revision: MaybeNumber = null) {
|
export function sendRefetch(target: RefetchKey, revision: MaybeNumber = null, rundownId?: string) {
|
||||||
socket.sendAsJson(MessageTag.Refetch, { target, revision });
|
socket.sendAsJson(MessageTag.Refetch, { target, revision, rundownId });
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,11 +1,13 @@
|
|||||||
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';
|
||||||
@@ -59,13 +61,24 @@ 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 {
|
||||||
return {
|
const rundown = { ...makeNewRundown(), ...patch };
|
||||||
...makeNewRundown(),
|
if (!patch.flatOrder) {
|
||||||
...patch,
|
const flatOrder: EntryId[] = [];
|
||||||
};
|
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', () => {
|
it('should return the updated data after commit is called and writes are scheduled', async () => {
|
||||||
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,8 +72,7 @@ describe('createTransaction', () => {
|
|||||||
colour: 'blue',
|
colour: 'blue',
|
||||||
};
|
};
|
||||||
|
|
||||||
const updated = commit();
|
const updated = await 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');
|
||||||
@@ -132,6 +131,23 @@ 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'],
|
||||||
@@ -1622,6 +1638,34 @@ 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()', () => {
|
||||||
|
|||||||
@@ -74,6 +74,7 @@ let rundownMetadata: RundownMetadata = {
|
|||||||
let projectCustomFields: CustomFields = {};
|
let projectCustomFields: CustomFields = {};
|
||||||
|
|
||||||
export const getCurrentRundown = (): Readonly<Rundown> => cachedRundown;
|
export const getCurrentRundown = (): Readonly<Rundown> => cachedRundown;
|
||||||
|
export const getCurrentRundownId = (): string => cachedRundown.id;
|
||||||
export const getRundownMetadata = (): Readonly<RundownMetadata> => rundownMetadata;
|
export const getRundownMetadata = (): Readonly<RundownMetadata> => rundownMetadata;
|
||||||
export const getProjectCustomFields = (): Readonly<CustomFields> => projectCustomFields;
|
export const getProjectCustomFields = (): Readonly<CustomFields> => projectCustomFields;
|
||||||
export const getEntryWithId = (entryId: EntryId): OntimeEntry | undefined => cachedRundown.entries[entryId];
|
export const getEntryWithId = (entryId: EntryId): OntimeEntry | undefined => cachedRundown.entries[entryId];
|
||||||
@@ -81,56 +82,85 @@ 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) => {
|
commit: (shouldProcess?: boolean) => Promise<{
|
||||||
rundown: Readonly<Rundown>;
|
rundown: Readonly<Rundown>;
|
||||||
rundownMetadata: Readonly<RundownMetadata>;
|
rundownMetadata: Readonly<RundownMetadata> | null;
|
||||||
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 rundown = options.mutableRundown ? structuredClone(cachedRundown) : cachedRundown;
|
const targetId = options.rundownId ?? cachedRundown.id;
|
||||||
|
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 the cache
|
* Applies a mutated rundown to its persistence target
|
||||||
* @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
|
||||||
*/
|
*/
|
||||||
function commit(shouldProcess: boolean = true) {
|
async 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) {
|
||||||
// update fields which are agnostic of whether the rundown is processed
|
if (isLoaded) {
|
||||||
cachedRundown.revision = cachedRundown.revision + 1;
|
// update fields which are agnostic of whether the rundown is processed
|
||||||
cachedRundown.title = rundown.title;
|
cachedRundown.revision = cachedRundown.revision + 1;
|
||||||
|
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 {
|
||||||
const processedData = processRundown(rundown, projectCustomFields);
|
// background rundown: process if requested, persist directly, no runtime metadata
|
||||||
// update the cache values
|
rundown.revision = rundown.revision + 1;
|
||||||
// eslint-disable-next-line @typescript-eslint/no-unused-vars -- we are not interested in the iteration data
|
if (shouldProcess) {
|
||||||
const { previousEvent, latestEvent, previousEntry, entries, order, ...metadata } = processedData;
|
const processedData = processRundown(rundown, projectCustomFields, { mutate: true });
|
||||||
|
rundown.entries = processedData.entries;
|
||||||
cachedRundown.entries = entries;
|
rundown.order = processedData.order;
|
||||||
cachedRundown.order = order;
|
rundown.flatOrder = processedData.flatEntryOrder;
|
||||||
cachedRundown.flatOrder = metadata.flatEntryOrder;
|
}
|
||||||
rundownMetadata = metadata;
|
await getDataProvider().setRundown(targetId, rundown);
|
||||||
|
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
|
||||||
@@ -138,21 +168,20 @@ export function createTransaction(options: TransactionOptions): Transaction {
|
|||||||
projectCustomFields = customFields;
|
projectCustomFields = customFields;
|
||||||
|
|
||||||
// persist after reassignment
|
// persist after reassignment
|
||||||
getDataProvider().setCustomFields(projectCustomFields);
|
await getDataProvider().setCustomFields(projectCustomFields);
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
rundown: cachedRundown,
|
rundown: committedRundown,
|
||||||
rundownMetadata,
|
rundownMetadata: committedMetadata,
|
||||||
customFields: projectCustomFields,
|
customFields: projectCustomFields,
|
||||||
revision: cachedRundown.revision,
|
revision: committedRevision,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
customFields,
|
customFields,
|
||||||
rundown,
|
rundown,
|
||||||
rundownMetadata,
|
|
||||||
commit,
|
commit,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
@@ -287,11 +316,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 = rundownMetadata.flatEntryOrder.indexOf(delay.id);
|
const delayIndex = rundown.flatOrder.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 === rundownMetadata.flatEntryOrder.length - 1) {
|
if (delay.duration === 0 || delayIndex === rundown.flatOrder.length - 1) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -304,8 +333,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 < rundownMetadata.flatEntryOrder.length; i++) {
|
for (let i = delayIndex + 1; i < rundown.flatOrder.length; i++) {
|
||||||
const currentId = rundownMetadata.flatEntryOrder[i];
|
const currentId = rundown.flatOrder[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
|
||||||
@@ -587,6 +616,23 @@ 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
|
||||||
*/
|
*/
|
||||||
@@ -665,7 +711,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);
|
const processedData = processRundown(rundown, customFields, { mutate: true });
|
||||||
|
|
||||||
// update the cache values
|
// update the cache values
|
||||||
cachedRundown.id = rundown.id;
|
cachedRundown.id = rundown.id;
|
||||||
@@ -698,72 +744,57 @@ export const rundownCache = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Utility updates cache after a mutation
|
* Computes derived rundown metadata (delays, gaps, group times, ordered lists).
|
||||||
* Handles calculating the rundown metadata
|
* By default the input rundown is not mutated — entries are cloned as they are processed.
|
||||||
|
* 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);
|
const { process, getMetadata } = makeRundownMetadata(customFields, options);
|
||||||
|
|
||||||
for (let i = 0; i < initialRundown.order.length; i++) {
|
for (let i = 0; i < initialRundown.order.length; i++) {
|
||||||
// we assign a reference to the current entry, this will be mutated in place
|
const currentEntry = initialRundown.entries[initialRundown.order[i]];
|
||||||
const currentEntryId = initialRundown.order[i];
|
if (!currentEntry) continue;
|
||||||
const currentEntry = initialRundown.entries[currentEntryId];
|
|
||||||
if (!currentEntry) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
const { processedEntry } = process(currentEntry, null);
|
|
||||||
|
|
||||||
// if the event is a group, we process the nested entries
|
const processedEntry = process(currentEntry, null);
|
||||||
// the code here is a copy of the processing of top level events
|
if (!isOntimeGroup(processedEntry)) continue;
|
||||||
if (isOntimeGroup(processedEntry)) {
|
|
||||||
let groupStartTime = null;
|
|
||||||
let groupEndTime = null;
|
|
||||||
let isFirstLinked = false;
|
|
||||||
const groupEvents: EntryId[] = [];
|
|
||||||
processedEntry.duration = 0;
|
|
||||||
|
|
||||||
// check if the group contains nested entries
|
// process nested entries and recompute aggregate group fields
|
||||||
for (let j = 0; j < processedEntry.entries.length; j++) {
|
let groupStartTime: number | null = null;
|
||||||
const nestedEntryId = processedEntry.entries[j];
|
let groupEndTime: number | null = null;
|
||||||
const nestedEntry = initialRundown.entries[nestedEntryId];
|
let isFirstLinked = false;
|
||||||
|
const groupEvents: EntryId[] = [];
|
||||||
|
processedEntry.duration = 0;
|
||||||
|
|
||||||
if (!nestedEntry) {
|
for (let j = 0; j < processedEntry.entries.length; j++) {
|
||||||
continue;
|
const nestedEntry = initialRundown.entries[processedEntry.entries[j]];
|
||||||
}
|
if (!nestedEntry) continue;
|
||||||
|
|
||||||
groupEvents.push(nestedEntry.id);
|
groupEvents.push(nestedEntry.id);
|
||||||
const { processedEntry: processedNestedEntry } = process(nestedEntry, processedEntry.id);
|
const processedNestedEntry = process(nestedEntry, processedEntry.id);
|
||||||
|
|
||||||
// we dont extract metadata of skipped events,
|
// skip metadata aggregation for non-playable nested entries
|
||||||
// if this is not a playable event there is nothing else to do
|
if (!isOntimeEvent(processedNestedEntry) || !isPlayableEvent(processedNestedEntry)) continue;
|
||||||
if (!isOntimeEvent(processedNestedEntry) || !isPlayableEvent(processedNestedEntry)) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
// first start is always the first event
|
if (groupStartTime === null) {
|
||||||
if (groupStartTime === null) {
|
groupStartTime = processedNestedEntry.timeStart;
|
||||||
groupStartTime = processedNestedEntry.timeStart;
|
isFirstLinked = Boolean(processedNestedEntry.linkStart);
|
||||||
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;
|
|
||||||
}
|
}
|
||||||
|
groupEndTime = processedNestedEntry.timeEnd;
|
||||||
// update group metadata
|
if (j > 0) {
|
||||||
processedEntry.timeStart = groupStartTime;
|
processedEntry.duration += processedNestedEntry.gap;
|
||||||
processedEntry.timeEnd = groupEndTime;
|
}
|
||||||
processedEntry.isFirstLinked = isFirstLinked;
|
processedEntry.duration += processedNestedEntry.duration;
|
||||||
processedEntry.entries = groupEvents;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
processedEntry.timeStart = groupStartTime;
|
||||||
|
processedEntry.timeEnd = groupEndTime;
|
||||||
|
processedEntry.isFirstLinked = isFirstLinked;
|
||||||
|
processedEntry.entries = groupEvents;
|
||||||
}
|
}
|
||||||
|
|
||||||
return getMetadata();
|
return getMetadata();
|
||||||
|
|||||||
@@ -205,10 +205,15 @@ 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) {
|
export function makeRundownMetadata(customFields: CustomFields, options?: { mutate?: boolean }) {
|
||||||
let rundownMeta: ProcessedRundownMetadata = {
|
const mutate = options?.mutate ?? false;
|
||||||
|
const rundownMeta: ProcessedRundownMetadata = {
|
||||||
totalDelay: 0,
|
totalDelay: 0,
|
||||||
totalDuration: 0,
|
totalDuration: 0,
|
||||||
totalDays: 0,
|
totalDays: 0,
|
||||||
@@ -228,13 +233,8 @@ export function makeRundownMetadata(customFields: CustomFields) {
|
|||||||
previousEntry: null,
|
previousEntry: null,
|
||||||
};
|
};
|
||||||
|
|
||||||
function process<T extends OntimeEntry>(
|
function process<T extends OntimeEntry>(entry: T, childOfGroup: EntryId | null): T {
|
||||||
entry: T,
|
return processEntry(rundownMeta, customFields, mutate ? entry : structuredClone(entry), childOfGroup);
|
||||||
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,20 +245,19 @@ export function makeRundownMetadata(customFields: CustomFields) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Processes a single entry and updates the rundown metadata
|
* Processes a single entry, mutating both `entry` and `rundownMetadata` in place.
|
||||||
|
* 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,
|
||||||
): { processedData: ProcessedRundownMetadata; processedEntry: T } {
|
): T {
|
||||||
const processedData = { ...rundownMetadata };
|
rundownMetadata.flatEntryOrder.push(entry.id);
|
||||||
const currentEntry = structuredClone(entry);
|
|
||||||
processedData.flatEntryOrder.push(currentEntry.id);
|
|
||||||
|
|
||||||
if (isOntimeEvent(currentEntry)) {
|
if (isOntimeEvent(entry)) {
|
||||||
processedData.timedEventOrder.push(currentEntry.id);
|
rundownMetadata.timedEventOrder.push(entry.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)
|
||||||
@@ -266,91 +265,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 (currentEntry.linkStart) {
|
if (entry.linkStart) {
|
||||||
if (processedData.previousEvent) {
|
if (rundownMetadata.previousEvent) {
|
||||||
const timePatch = getLinkedTimes(currentEntry, processedData.previousEvent);
|
const timePatch = getLinkedTimes(entry, rundownMetadata.previousEvent);
|
||||||
currentEntry.timeStart = timePatch.timeStart;
|
entry.timeStart = timePatch.timeStart;
|
||||||
currentEntry.timeEnd = timePatch.timeEnd;
|
entry.timeEnd = timePatch.timeEnd;
|
||||||
currentEntry.duration = timePatch.duration;
|
entry.duration = timePatch.duration;
|
||||||
} else {
|
} else {
|
||||||
currentEntry.linkStart = false;
|
entry.linkStart = false;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// 2. handle custom fields - mutates currentEntry
|
// 2. handle custom fields - mutates entry
|
||||||
sanitiseCustomFields(customFields, currentEntry);
|
sanitiseCustomFields(customFields, entry);
|
||||||
|
|
||||||
processedData.totalDays += calculateDayOffset(currentEntry, processedData.previousEvent);
|
rundownMetadata.totalDays += calculateDayOffset(entry, rundownMetadata.previousEvent);
|
||||||
currentEntry.dayOffset = processedData.totalDays as Day;
|
entry.dayOffset = rundownMetadata.totalDays as Day;
|
||||||
currentEntry.delay = 0; // this means we dont calculate delays or gaps for skipped events
|
entry.delay = 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.gap = 0; // this means we dont calculate delays or gaps for skipped events
|
||||||
currentEntry.parent = childOfGroup;
|
entry.parent = childOfGroup;
|
||||||
|
|
||||||
// update rundown metadata, it only concerns playable events
|
// update rundown metadata, it only concerns playable events
|
||||||
if (isPlayableEvent(currentEntry)) {
|
if (isPlayableEvent(entry)) {
|
||||||
processedData.playableEventOrder.push(currentEntry.id);
|
rundownMetadata.playableEventOrder.push(entry.id);
|
||||||
|
|
||||||
// first start is always the first event
|
// first start is always the first event
|
||||||
if (processedData.firstStart === null) {
|
if (rundownMetadata.firstStart === null) {
|
||||||
processedData.firstStart = currentEntry.timeStart;
|
rundownMetadata.firstStart = entry.timeStart;
|
||||||
}
|
}
|
||||||
|
|
||||||
// check if event is flagged
|
// check if event is flagged
|
||||||
if (currentEntry.flag) {
|
if (entry.flag) {
|
||||||
processedData.flags.push(currentEntry.id);
|
rundownMetadata.flags.push(entry.id);
|
||||||
}
|
}
|
||||||
|
|
||||||
currentEntry.gap = getTimeFrom(currentEntry, processedData.latestEvent);
|
entry.gap = getTimeFrom(entry, rundownMetadata.latestEvent);
|
||||||
|
|
||||||
if (currentEntry.gap === 0) {
|
if (entry.gap === 0) {
|
||||||
// event starts on previous finish, we add its duration
|
// event starts on previous finish, we add its duration
|
||||||
processedData.totalDuration += currentEntry.duration;
|
rundownMetadata.totalDuration += entry.duration;
|
||||||
} else if (currentEntry.gap > 0) {
|
} else if (entry.gap > 0) {
|
||||||
// event has a gap, we add the gap and the duration
|
// event has a gap, we add the gap and the duration
|
||||||
processedData.totalDuration += currentEntry.gap + currentEntry.duration;
|
rundownMetadata.totalDuration += entry.gap + entry.duration;
|
||||||
} else if (currentEntry.gap < 0) {
|
} else {
|
||||||
// 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
|
||||||
processedData.totalDuration += Math.max(currentEntry.duration + currentEntry.gap, 0);
|
rundownMetadata.totalDuration += Math.max(entry.duration + entry.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 (processedData.totalDelay > 0 && currentEntry.gap > 0) {
|
if (rundownMetadata.totalDelay > 0 && entry.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(processedData.previousEntry)) {
|
if (isOntimeDelay(rundownMetadata.previousEntry)) {
|
||||||
correctedDelay = processedData.previousEntry.duration;
|
correctedDelay = rundownMetadata.previousEntry.duration;
|
||||||
processedData.totalDelay -= correctedDelay;
|
rundownMetadata.totalDelay -= correctedDelay;
|
||||||
}
|
}
|
||||||
processedData.totalDelay = Math.max(processedData.totalDelay - currentEntry.gap, 0);
|
rundownMetadata.totalDelay = Math.max(rundownMetadata.totalDelay - entry.gap, 0);
|
||||||
processedData.totalDelay += correctedDelay;
|
rundownMetadata.totalDelay += correctedDelay;
|
||||||
}
|
}
|
||||||
|
|
||||||
// current event delay is the current accumulated delay
|
// current event delay is the current accumulated delay
|
||||||
currentEntry.delay = processedData.totalDelay;
|
entry.delay = rundownMetadata.totalDelay;
|
||||||
|
|
||||||
// assign data for next iteration
|
// assign data for next iteration
|
||||||
processedData.previousEvent = currentEntry;
|
rundownMetadata.previousEvent = entry;
|
||||||
|
|
||||||
// lastEntry is the event with the latest end time
|
// lastEntry is the event with the latest end time
|
||||||
if (isNewLatest(currentEntry, processedData.latestEvent)) {
|
if (isNewLatest(entry, rundownMetadata.latestEvent)) {
|
||||||
processedData.latestEvent = currentEntry;
|
rundownMetadata.latestEvent = entry;
|
||||||
processedData.lastEnd = currentEntry.timeEnd;
|
rundownMetadata.lastEnd = entry.timeEnd;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} else if (isOntimeDelay(currentEntry)) {
|
} else if (isOntimeDelay(entry)) {
|
||||||
// !!! this must happen after handling the links
|
// !!! this must happen after handling the links
|
||||||
processedData.totalDelay += currentEntry.duration;
|
rundownMetadata.totalDelay += entry.duration;
|
||||||
currentEntry.parent = childOfGroup;
|
entry.parent = childOfGroup;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!childOfGroup) {
|
if (!childOfGroup) {
|
||||||
processedData.order.push(currentEntry.id);
|
rundownMetadata.order.push(entry.id);
|
||||||
}
|
}
|
||||||
processedData.entries[currentEntry.id] = currentEntry;
|
rundownMetadata.entries[entry.id] = entry;
|
||||||
processedData.previousEntry = currentEntry;
|
rundownMetadata.previousEntry = entry;
|
||||||
|
|
||||||
return { processedData, processedEntry: currentEntry };
|
return entry;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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 } from './rundown.dao.js';
|
import { getCurrentRundown, getProcessedRundown } from './rundown.dao.js';
|
||||||
import {
|
import {
|
||||||
addEntry,
|
addEntry,
|
||||||
applyDelay,
|
applyDelay,
|
||||||
batchEditEntries,
|
batchEditEntries,
|
||||||
cloneEntry,
|
cloneEntry,
|
||||||
|
createNewRundown,
|
||||||
deleteAllEntries,
|
deleteAllEntries,
|
||||||
deleteEntries,
|
deleteEntries,
|
||||||
editEntry,
|
editEntry,
|
||||||
@@ -35,7 +35,6 @@ 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();
|
||||||
@@ -58,6 +57,19 @@ 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
|
||||||
*/
|
*/
|
||||||
@@ -76,11 +88,7 @@ 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 emptyRundown = makeNewRundown();
|
const projectRundowns = await createNewRundown(req.body.title);
|
||||||
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);
|
||||||
@@ -180,10 +188,9 @@ 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.body);
|
const newEvent = await addEntry(req.params.rundownId, req.body);
|
||||||
res.status(201).send(newEvent);
|
res.status(201).send(newEvent);
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
const message = getErrorMessage(error);
|
const message = getErrorMessage(error);
|
||||||
@@ -195,20 +202,15 @@ router.post(
|
|||||||
/**
|
/**
|
||||||
* Edits an entry in a given rundown
|
* Edits an entry in a given rundown
|
||||||
*/
|
*/
|
||||||
router.put(
|
router.put('/:rundownId/entry', entryPutValidator, async (req: Request, res: Response<OntimeEntry | ErrorResponse>) => {
|
||||||
'/:rundownId/entry',
|
try {
|
||||||
entryPutValidator,
|
const event = await editEntry(req.params.rundownId, req.body);
|
||||||
validateRundownMutation,
|
res.status(200).send(event);
|
||||||
async (req: Request, res: Response<OntimeEntry | ErrorResponse>) => {
|
} catch (error) {
|
||||||
try {
|
const message = getErrorMessage(error);
|
||||||
const event = await editEntry(req.body);
|
res.status(400).send({ message });
|
||||||
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
|
||||||
@@ -216,10 +218,9 @@ router.put(
|
|||||||
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.body.ids, req.body.data);
|
const rundown = await batchEditEntries(req.params.rundownId, 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);
|
||||||
@@ -234,11 +235,10 @@ 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(entryId, destinationId, order);
|
const rundown = await reorderEntry(req.params.rundownId, 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,10 +253,9 @@ 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.id);
|
const rundown = await applyDelay(req.params.rundownId, 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);
|
||||||
@@ -268,20 +267,15 @@ router.patch(
|
|||||||
/**
|
/**
|
||||||
* Swaps data between two Ontime events
|
* Swaps data between two Ontime events
|
||||||
*/
|
*/
|
||||||
router.patch(
|
router.patch('/:rundownId/swap', entrySwapValidator, async (req: Request, res: Response<Rundown | ErrorResponse>) => {
|
||||||
'/:rundownId/swap',
|
try {
|
||||||
entrySwapValidator,
|
const rundown = await swapEvents(req.params.rundownId, req.body.from, req.body.to);
|
||||||
validateRundownMutation,
|
res.status(200).send(rundown);
|
||||||
async (req: Request, res: Response<Rundown | ErrorResponse>) => {
|
} catch (error) {
|
||||||
try {
|
const message = getErrorMessage(error);
|
||||||
const rundown = await swapEvents(req.body.from, req.body.to);
|
res.status(400).send({ message });
|
||||||
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
|
||||||
@@ -290,10 +284,9 @@ 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.id, {
|
const rundown = await cloneEntry(req.params.rundownId, req.params.id, {
|
||||||
before: req.body?.before,
|
before: req.body?.before,
|
||||||
after: req.body?.after,
|
after: req.body?.after,
|
||||||
});
|
});
|
||||||
@@ -308,38 +301,28 @@ router.post(
|
|||||||
/**
|
/**
|
||||||
* Creates a group out of a list of entries
|
* Creates a group out of a list of entries
|
||||||
*/
|
*/
|
||||||
router.post(
|
router.post('/:rundownId/group', rundownArrayOfIds, async (req: Request, res: Response<Rundown | ErrorResponse>) => {
|
||||||
'/:rundownId/group',
|
try {
|
||||||
rundownArrayOfIds,
|
const rundown = await groupEntries(req.params.rundownId, req.body.ids);
|
||||||
validateRundownMutation,
|
res.status(200).send(rundown);
|
||||||
async (req: Request, res: Response<Rundown | ErrorResponse>) => {
|
} catch (error) {
|
||||||
try {
|
const message = getErrorMessage(error);
|
||||||
const rundown = await groupEntries(req.body.ids);
|
res.status(400).send({ message });
|
||||||
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(
|
router.post('/:rundownId/ungroup/:id', paramsWithId, async (req: Request, res: Response<Rundown | ErrorResponse>) => {
|
||||||
'/:rundownId/ungroup/:id',
|
try {
|
||||||
paramsWithId,
|
const rundown = await ungroupEntries(req.params.rundownId, req.params.id);
|
||||||
validateRundownMutation,
|
res.status(200).send(rundown);
|
||||||
async (req: Request, res: Response<Rundown | ErrorResponse>) => {
|
} catch (error) {
|
||||||
try {
|
const message = getErrorMessage(error);
|
||||||
const rundown = await ungroupEntries(req.params.id);
|
res.status(400).send({ message });
|
||||||
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
|
||||||
@@ -347,10 +330,9 @@ router.post(
|
|||||||
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.body.ids);
|
const rundown = await deleteEntries(req.params.rundownId, 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);
|
||||||
@@ -362,19 +344,15 @@ router.delete(
|
|||||||
/**
|
/**
|
||||||
* Deletes all entries in a given rundown
|
* Deletes all entries in a given rundown
|
||||||
*/
|
*/
|
||||||
router.delete(
|
router.delete('/:rundownId/all', async (req: Request, res: Response<Rundown | ErrorResponse>) => {
|
||||||
'/:rundownId/all',
|
try {
|
||||||
validateRundownMutation,
|
const rundown = await deleteAllEntries(req.params.rundownId);
|
||||||
async (_req: Request, res: Response<Rundown | ErrorResponse>) => {
|
res.status(200).send(rundown);
|
||||||
try {
|
} catch (error) {
|
||||||
const rundown = await deleteAllEntries();
|
const message = getErrorMessage(error);
|
||||||
res.status(200).send(rundown);
|
res.status(400).send({ message });
|
||||||
} catch (error) {
|
}
|
||||||
const message = getErrorMessage(error);
|
});
|
||||||
res.status(400).send({ message });
|
|
||||||
}
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Reorders two entries in a rundown
|
* Reorders two entries in a rundown
|
||||||
@@ -382,11 +360,10 @@ router.delete(
|
|||||||
router.patch(
|
router.patch(
|
||||||
'/:rundownId/renumber',
|
'/:rundownId/renumber',
|
||||||
entryRenumberValidator,
|
entryRenumberValidator,
|
||||||
validateRundownMutation,
|
async (req: Request, res: Response<Rundown | ErrorResponse>) => {
|
||||||
(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 = renumberEntries(ids, prefix, start, increment);
|
const rundown = await renumberEntries(req.params.rundownId, 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,13 +21,14 @@ 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';
|
||||||
import {
|
import {
|
||||||
createTransaction,
|
createTransaction,
|
||||||
customFieldMutation,
|
customFieldMutation,
|
||||||
getCurrentRundown,
|
getCurrentRundownId,
|
||||||
rundownCache,
|
rundownCache,
|
||||||
rundownMutation,
|
rundownMutation,
|
||||||
updateBackgroundRundown,
|
updateBackgroundRundown,
|
||||||
@@ -38,8 +39,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(eventData: EventPostPayload): Promise<OntimeEntry> {
|
export async function addEntry(rundownId: string, eventData: EventPostPayload): Promise<OntimeEntry> {
|
||||||
const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
|
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true });
|
||||||
|
|
||||||
// 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)) {
|
||||||
@@ -66,7 +67,7 @@ export async function addEntry(eventData: EventPostPayload): Promise<OntimeEntry
|
|||||||
// make mutations to rundown
|
// make mutations to rundown
|
||||||
rundownMutation.add(rundown, newEntry, afterId, parent);
|
rundownMutation.add(rundown, newEntry, afterId, parent);
|
||||||
|
|
||||||
const { rundownMetadata, revision } = commit();
|
const { rundown: responseRundown, rundownMetadata, revision } = await commit();
|
||||||
|
|
||||||
// schedule the side effects
|
// schedule the side effects
|
||||||
setImmediate(() => {
|
setImmediate(() => {
|
||||||
@@ -74,17 +75,17 @@ export async function addEntry(eventData: EventPostPayload): Promise<OntimeEntry
|
|||||||
updateRuntimeOnChange(rundownMetadata);
|
updateRuntimeOnChange(rundownMetadata);
|
||||||
|
|
||||||
// notify timer and external services of change
|
// notify timer and external services of change
|
||||||
notifyChanges(rundownMetadata, revision, { timer: [newEntry.id], external: true });
|
notifyChanges(rundown.id, rundownMetadata, revision, { timer: [newEntry.id], external: true });
|
||||||
});
|
});
|
||||||
|
|
||||||
return newEntry;
|
return responseRundown.entries[newEntry.id] ?? newEntry;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Applies a patch to an entry in the rundown
|
* Applies a patch to an entry in the rundown
|
||||||
*/
|
*/
|
||||||
export async function editEntry(patch: PatchWithId): Promise<OntimeEntry> {
|
export async function editEntry(rundownId: string, patch: PatchWithId): Promise<OntimeEntry> {
|
||||||
const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
|
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true });
|
||||||
const currentEntry = rundown.entries[patch.id];
|
const currentEntry = rundown.entries[patch.id];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -110,7 +111,7 @@ export async function editEntry(patch: PatchWithId): Promise<OntimeEntry> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const { entry, didInvalidate } = rundownMutation.edit(rundown, patch);
|
const { entry, didInvalidate } = rundownMutation.edit(rundown, patch);
|
||||||
const { rundownMetadata, revision } = commit(didInvalidate);
|
const { rundown: responseRundown, rundownMetadata, revision } = await commit(didInvalidate);
|
||||||
|
|
||||||
// schedule the side effects
|
// schedule the side effects
|
||||||
setImmediate(() => {
|
setImmediate(() => {
|
||||||
@@ -118,17 +119,24 @@ export async function editEntry(patch: PatchWithId): Promise<OntimeEntry> {
|
|||||||
updateRuntimeOnChange(rundownMetadata);
|
updateRuntimeOnChange(rundownMetadata);
|
||||||
|
|
||||||
// notify timer and external services of change
|
// notify timer and external services of change
|
||||||
notifyChanges(rundownMetadata, revision, { timer: didInvalidate ? true : [entry.id], external: true });
|
notifyChanges(rundown.id, rundownMetadata, revision, {
|
||||||
|
timer: didInvalidate ? true : [entry.id],
|
||||||
|
external: true,
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
return entry;
|
return responseRundown.entries[entry.id] ?? entry;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Applies a patch to several entries in the rundown
|
* Applies a patch to several entries in the rundown
|
||||||
*/
|
*/
|
||||||
export async function batchEditEntries(ids: EntryId[], patch: Partial<OntimeEntry>): Promise<Rundown> {
|
export async function batchEditEntries(
|
||||||
const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
|
rundownId: string,
|
||||||
|
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
|
||||||
@@ -173,7 +181,7 @@ export async function batchEditEntries(ids: EntryId[], patch: Partial<OntimeEntr
|
|||||||
batchDidInvalidate = true;
|
batchDidInvalidate = true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
const { rundown: rundownResult, rundownMetadata, revision } = commit(batchDidInvalidate);
|
const { rundown: rundownResult, rundownMetadata, revision } = await commit(batchDidInvalidate);
|
||||||
|
|
||||||
// schedule the side effects
|
// schedule the side effects
|
||||||
setImmediate(() => {
|
setImmediate(() => {
|
||||||
@@ -181,7 +189,10 @@ export async function batchEditEntries(ids: EntryId[], patch: Partial<OntimeEntr
|
|||||||
updateRuntimeOnChange(rundownMetadata);
|
updateRuntimeOnChange(rundownMetadata);
|
||||||
|
|
||||||
// notify timer and external services of change
|
// notify timer and external services of change
|
||||||
notifyChanges(rundownMetadata, revision, { timer: batchDidInvalidate ? true : changedIds, external: true });
|
notifyChanges(rundown.id, rundownMetadata, revision, {
|
||||||
|
timer: batchDidInvalidate ? true : changedIds,
|
||||||
|
external: true,
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
return rundownResult;
|
return rundownResult;
|
||||||
@@ -190,8 +201,8 @@ export async function batchEditEntries(ids: EntryId[], patch: Partial<OntimeEntr
|
|||||||
/**
|
/**
|
||||||
* Deletes a known entry from the current rundown
|
* Deletes a known entry from the current rundown
|
||||||
*/
|
*/
|
||||||
export async function deleteEntries(entryIds: EntryId[]): Promise<Rundown> {
|
export async function deleteEntries(rundownId: string, entryIds: EntryId[]): Promise<Rundown> {
|
||||||
const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
|
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true });
|
||||||
|
|
||||||
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]];
|
||||||
@@ -201,7 +212,7 @@ export async function deleteEntries(entryIds: EntryId[]): Promise<Rundown> {
|
|||||||
rundownMutation.remove(rundown, entry);
|
rundownMutation.remove(rundown, entry);
|
||||||
}
|
}
|
||||||
|
|
||||||
const { rundown: rundownResult, rundownMetadata, revision } = commit();
|
const { rundown: rundownResult, rundownMetadata, revision } = await commit();
|
||||||
|
|
||||||
// schedule the side effects
|
// schedule the side effects
|
||||||
setImmediate(() => {
|
setImmediate(() => {
|
||||||
@@ -209,7 +220,7 @@ export async function deleteEntries(entryIds: EntryId[]): Promise<Rundown> {
|
|||||||
updateRuntimeOnChange(rundownMetadata);
|
updateRuntimeOnChange(rundownMetadata);
|
||||||
|
|
||||||
// notify timer and external services of change
|
// notify timer and external services of change
|
||||||
notifyChanges(rundownMetadata, revision, { timer: entryIds, external: true });
|
notifyChanges(rundown.id, rundownMetadata, revision, { timer: entryIds, external: true });
|
||||||
});
|
});
|
||||||
|
|
||||||
return rundownResult;
|
return rundownResult;
|
||||||
@@ -218,12 +229,12 @@ export async function deleteEntries(entryIds: EntryId[]): Promise<Rundown> {
|
|||||||
/**
|
/**
|
||||||
* Deletes all entries from the current rundown
|
* Deletes all entries from the current rundown
|
||||||
*/
|
*/
|
||||||
export async function deleteAllEntries(): Promise<Rundown> {
|
export async function deleteAllEntries(rundownId: string): Promise<Rundown> {
|
||||||
const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
|
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true });
|
||||||
|
|
||||||
rundownMutation.removeAll(rundown);
|
rundownMutation.removeAll(rundown);
|
||||||
|
|
||||||
const { rundown: rundownResult, rundownMetadata, revision } = commit();
|
const { rundown: rundownResult, rundownMetadata, revision } = await commit();
|
||||||
|
|
||||||
// schedule the side effects
|
// schedule the side effects
|
||||||
setImmediate(() => {
|
setImmediate(() => {
|
||||||
@@ -231,7 +242,7 @@ export async function deleteAllEntries(): Promise<Rundown> {
|
|||||||
updateRuntimeOnChange(rundownMetadata);
|
updateRuntimeOnChange(rundownMetadata);
|
||||||
|
|
||||||
// notify timer and external services of change
|
// notify timer and external services of change
|
||||||
notifyChanges(rundownMetadata, revision, { timer: true, external: true });
|
notifyChanges(rundown.id, rundownMetadata, revision, { timer: true, external: true });
|
||||||
});
|
});
|
||||||
|
|
||||||
return rundownResult;
|
return rundownResult;
|
||||||
@@ -242,8 +253,13 @@ export async function deleteAllEntries(): 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(entryId: EntryId, destinationId: EntryId, order: 'before' | 'after' | 'insert') {
|
export async function reorderEntry(
|
||||||
const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
|
rundownId: string,
|
||||||
|
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];
|
||||||
@@ -255,7 +271,7 @@ export async function reorderEntry(entryId: EntryId, destinationId: EntryId, ord
|
|||||||
|
|
||||||
rundownMutation.reorder(rundown, eventFrom, eventTo, order);
|
rundownMutation.reorder(rundown, eventFrom, eventTo, order);
|
||||||
|
|
||||||
const { rundown: rundownResult, rundownMetadata, revision } = commit();
|
const { rundown: rundownResult, rundownMetadata, revision } = await commit();
|
||||||
|
|
||||||
// schedule the side effects
|
// schedule the side effects
|
||||||
setImmediate(() => {
|
setImmediate(() => {
|
||||||
@@ -263,7 +279,7 @@ export async function reorderEntry(entryId: EntryId, destinationId: EntryId, ord
|
|||||||
updateRuntimeOnChange(rundownMetadata);
|
updateRuntimeOnChange(rundownMetadata);
|
||||||
|
|
||||||
// notify timer and external services of change
|
// notify timer and external services of change
|
||||||
notifyChanges(rundownMetadata, revision, { timer: true, external: true });
|
notifyChanges(rundown.id, rundownMetadata, revision, { timer: true, external: true });
|
||||||
});
|
});
|
||||||
|
|
||||||
return rundownResult;
|
return rundownResult;
|
||||||
@@ -272,22 +288,28 @@ export async function reorderEntry(entryId: EntryId, destinationId: EntryId, ord
|
|||||||
/**
|
/**
|
||||||
* @throws if an id is missing or not an Ontime event
|
* @throws if an id is missing or not an Ontime event
|
||||||
*/
|
*/
|
||||||
export function renumberEntries(ids: EntryId[], prefix: string, start: string, increment: string): Rundown {
|
export async function renumberEntries(
|
||||||
|
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({ mutableRundown: true, mutableCustomFields: false });
|
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true, mutableCustomFields: false });
|
||||||
|
|
||||||
rundownMutation.renumber(rundown, ids, prefix, startNumber, incrementNumber);
|
rundownMutation.renumber(rundown, ids, prefix, startNumber, incrementNumber);
|
||||||
|
|
||||||
const { rundown: rundownResult, rundownMetadata, revision } = commit(false);
|
const { rundown: rundownResult, rundownMetadata, revision } = await commit(false);
|
||||||
|
|
||||||
setImmediate(() => {
|
setImmediate(() => {
|
||||||
updateRuntimeOnChange(rundownMetadata);
|
updateRuntimeOnChange(rundownMetadata);
|
||||||
notifyChanges(rundownMetadata, revision, { timer: ids, external: true });
|
notifyChanges(rundown.id, rundownMetadata, revision, { timer: ids, external: true });
|
||||||
});
|
});
|
||||||
|
|
||||||
return rundownResult;
|
return rundownResult;
|
||||||
@@ -297,8 +319,8 @@ export function renumberEntries(ids: EntryId[], prefix: string, start: string, i
|
|||||||
* 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(delayId: EntryId): Promise<Rundown> {
|
export async function applyDelay(rundownId: string, delayId: EntryId): Promise<Rundown> {
|
||||||
const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
|
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true });
|
||||||
|
|
||||||
// check that delay exists
|
// check that delay exists
|
||||||
const delay = rundown.entries[delayId];
|
const delay = rundown.entries[delayId];
|
||||||
@@ -310,7 +332,7 @@ export async function applyDelay(delayId: EntryId): Promise<Rundown> {
|
|||||||
rundownMutation.applyDelay(rundown, delay);
|
rundownMutation.applyDelay(rundown, delay);
|
||||||
rundownMutation.remove(rundown, delay);
|
rundownMutation.remove(rundown, delay);
|
||||||
|
|
||||||
const { rundown: rundownResult, rundownMetadata, revision } = commit();
|
const { rundown: rundownResult, rundownMetadata, revision } = await commit();
|
||||||
|
|
||||||
// schedule the side effects
|
// schedule the side effects
|
||||||
setImmediate(() => {
|
setImmediate(() => {
|
||||||
@@ -318,7 +340,7 @@ export async function applyDelay(delayId: EntryId): Promise<Rundown> {
|
|||||||
updateRuntimeOnChange(rundownMetadata);
|
updateRuntimeOnChange(rundownMetadata);
|
||||||
|
|
||||||
// notify timer and external services of change
|
// notify timer and external services of change
|
||||||
notifyChanges(rundownMetadata, revision, { timer: true, external: true });
|
notifyChanges(rundown.id, rundownMetadata, revision, { timer: true, external: true });
|
||||||
});
|
});
|
||||||
|
|
||||||
return rundownResult;
|
return rundownResult;
|
||||||
@@ -327,8 +349,8 @@ export async function applyDelay(delayId: EntryId): Promise<Rundown> {
|
|||||||
/**
|
/**
|
||||||
* Swaps the data between two events in the rundown
|
* Swaps the data between two events in the rundown
|
||||||
*/
|
*/
|
||||||
export async function swapEvents(fromId: EntryId, toId: EntryId): Promise<Rundown> {
|
export async function swapEvents(rundownId: string, fromId: EntryId, toId: EntryId): Promise<Rundown> {
|
||||||
const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
|
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true });
|
||||||
const eventFrom = rundown.entries[fromId];
|
const eventFrom = rundown.entries[fromId];
|
||||||
const eventTo = rundown.entries[toId];
|
const eventTo = rundown.entries[toId];
|
||||||
|
|
||||||
@@ -343,7 +365,7 @@ export async function swapEvents(fromId: EntryId, toId: EntryId): Promise<Rundow
|
|||||||
}
|
}
|
||||||
|
|
||||||
rundownMutation.swap(rundown, eventFrom, eventTo);
|
rundownMutation.swap(rundown, eventFrom, eventTo);
|
||||||
const { rundown: rundownResult, rundownMetadata, revision } = commit();
|
const { rundown: rundownResult, rundownMetadata, revision } = await commit();
|
||||||
|
|
||||||
// schedule the side effects
|
// schedule the side effects
|
||||||
setImmediate(() => {
|
setImmediate(() => {
|
||||||
@@ -351,7 +373,7 @@ export async function swapEvents(fromId: EntryId, toId: EntryId): Promise<Rundow
|
|||||||
updateRuntimeOnChange(rundownMetadata);
|
updateRuntimeOnChange(rundownMetadata);
|
||||||
|
|
||||||
// notify timer and external services of change
|
// notify timer and external services of change
|
||||||
notifyChanges(rundownMetadata, revision, { timer: true, external: true });
|
notifyChanges(rundown.id, rundownMetadata, revision, { timer: true, external: true });
|
||||||
});
|
});
|
||||||
|
|
||||||
return rundownResult;
|
return rundownResult;
|
||||||
@@ -362,8 +384,8 @@ export async function swapEvents(fromId: EntryId, toId: EntryId): Promise<Rundow
|
|||||||
* 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(entryId: EntryId, options: InsertOptions): Promise<Rundown> {
|
export async function cloneEntry(rundownId: string, entryId: EntryId, options: InsertOptions): Promise<Rundown> {
|
||||||
const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
|
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true });
|
||||||
const originalEntry = rundown.entries[entryId];
|
const originalEntry = rundown.entries[entryId];
|
||||||
|
|
||||||
if (!originalEntry) {
|
if (!originalEntry) {
|
||||||
@@ -371,7 +393,7 @@ export async function cloneEntry(entryId: EntryId, options: InsertOptions): Prom
|
|||||||
}
|
}
|
||||||
|
|
||||||
const newEntry = rundownMutation.clone(rundown, originalEntry, options);
|
const newEntry = rundownMutation.clone(rundown, originalEntry, options);
|
||||||
const { rundown: rundownResult, rundownMetadata, revision } = commit();
|
const { rundown: rundownResult, rundownMetadata, revision } = await commit();
|
||||||
|
|
||||||
// schedule the side effects
|
// schedule the side effects
|
||||||
setImmediate(() => {
|
setImmediate(() => {
|
||||||
@@ -380,11 +402,11 @@ export async function cloneEntry(entryId: EntryId, options: InsertOptions): Prom
|
|||||||
|
|
||||||
// notify timer and external services of change
|
// notify timer and external services of change
|
||||||
if (isOntimeGroup(newEntry)) {
|
if (isOntimeGroup(newEntry)) {
|
||||||
notifyChanges(rundownMetadata, revision, { timer: newEntry.entries, external: true });
|
notifyChanges(rundown.id, rundownMetadata, revision, { timer: newEntry.entries, external: true });
|
||||||
} else if (isOntimeEvent(newEntry)) {
|
} else if (isOntimeEvent(newEntry)) {
|
||||||
notifyChanges(rundownMetadata, revision, { timer: [newEntry.id], external: true });
|
notifyChanges(rundown.id, rundownMetadata, revision, { timer: [newEntry.id], external: true });
|
||||||
} else if (isOntimeDelay(newEntry)) {
|
} else if (isOntimeDelay(newEntry)) {
|
||||||
notifyChanges(rundownMetadata, revision, { external: true });
|
notifyChanges(rundown.id, rundownMetadata, revision, { external: true });
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -394,11 +416,11 @@ export async function cloneEntry(entryId: EntryId, options: InsertOptions): Prom
|
|||||||
/**
|
/**
|
||||||
* Groups a list of entries into a new group
|
* Groups a list of entries into a new group
|
||||||
*/
|
*/
|
||||||
export async function groupEntries(entryIds: EntryId[]): Promise<Rundown> {
|
export async function groupEntries(rundownId: string, entryIds: EntryId[]): Promise<Rundown> {
|
||||||
const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
|
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true });
|
||||||
|
|
||||||
rundownMutation.group(rundown, entryIds);
|
rundownMutation.group(rundown, entryIds);
|
||||||
const { rundown: rundownResult, rundownMetadata, revision } = commit();
|
const { rundown: rundownResult, rundownMetadata, revision } = await commit();
|
||||||
|
|
||||||
// schedule the side effects
|
// schedule the side effects
|
||||||
setImmediate(() => {
|
setImmediate(() => {
|
||||||
@@ -406,7 +428,7 @@ export async function groupEntries(entryIds: EntryId[]): Promise<Rundown> {
|
|||||||
updateRuntimeOnChange(rundownMetadata);
|
updateRuntimeOnChange(rundownMetadata);
|
||||||
|
|
||||||
// we need to notify the timer since we might be grouping a running event
|
// we need to notify the timer since we might be grouping a running event
|
||||||
notifyChanges(rundownMetadata, revision, { external: true, timer: true });
|
notifyChanges(rundown.id, rundownMetadata, revision, { external: true, timer: true });
|
||||||
});
|
});
|
||||||
|
|
||||||
return rundownResult;
|
return rundownResult;
|
||||||
@@ -415,8 +437,8 @@ export async function groupEntries(entryIds: EntryId[]): Promise<Rundown> {
|
|||||||
/**
|
/**
|
||||||
* 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(groupId: EntryId): Promise<Rundown> {
|
export async function ungroupEntries(rundownId: string, groupId: EntryId): Promise<Rundown> {
|
||||||
const { rundown, commit } = createTransaction({ mutableRundown: true, mutableCustomFields: false });
|
const { rundown, commit } = createTransaction({ rundownId, mutableRundown: true });
|
||||||
|
|
||||||
const group = rundown.entries[groupId];
|
const group = rundown.entries[groupId];
|
||||||
if (!group || !isOntimeGroup(group)) {
|
if (!group || !isOntimeGroup(group)) {
|
||||||
@@ -424,7 +446,7 @@ export async function ungroupEntries(groupId: EntryId): Promise<Rundown> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
rundownMutation.ungroup(rundown, group);
|
rundownMutation.ungroup(rundown, group);
|
||||||
const { rundown: rundownResult, rundownMetadata, revision } = commit();
|
const { rundown: rundownResult, rundownMetadata, revision } = await commit();
|
||||||
|
|
||||||
// schedule the side effects
|
// schedule the side effects
|
||||||
setImmediate(() => {
|
setImmediate(() => {
|
||||||
@@ -432,7 +454,7 @@ export async function ungroupEntries(groupId: EntryId): Promise<Rundown> {
|
|||||||
updateRuntimeOnChange(rundownMetadata);
|
updateRuntimeOnChange(rundownMetadata);
|
||||||
|
|
||||||
// we dont need to notify the timer since the grouping does not affect the runtime
|
// we dont need to notify the timer since the grouping does not affect the runtime
|
||||||
notifyChanges(rundownMetadata, revision, { external: true });
|
notifyChanges(rundown.id, rundownMetadata, revision, { external: true });
|
||||||
});
|
});
|
||||||
|
|
||||||
return rundownResult;
|
return rundownResult;
|
||||||
@@ -459,7 +481,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 } = commit(false);
|
const { customFields: resultCustomFields } = await commit(false);
|
||||||
|
|
||||||
setImmediate(() => {
|
setImmediate(() => {
|
||||||
sendRefetch(RefetchKey.CustomFields);
|
sendRefetch(RefetchKey.CustomFields);
|
||||||
@@ -517,12 +539,12 @@ 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 } = commit(false);
|
const { rundownMetadata, revision, customFields: resultCustomFields } = await commit(false);
|
||||||
|
|
||||||
// schedule the side effects
|
// schedule the side effects
|
||||||
setImmediate(() => {
|
setImmediate(() => {
|
||||||
sendRefetch(RefetchKey.CustomFields);
|
sendRefetch(RefetchKey.CustomFields);
|
||||||
notifyChanges(rundownMetadata, revision, { timer: true, external: true });
|
notifyChanges(undefined, rundownMetadata, revision, { timer: true, external: true });
|
||||||
});
|
});
|
||||||
|
|
||||||
return resultCustomFields;
|
return resultCustomFields;
|
||||||
@@ -556,12 +578,12 @@ 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 } = commit(false);
|
const { rundownMetadata, revision, customFields: resultCustomFields } = await commit(false);
|
||||||
|
|
||||||
// schedule the side effects
|
// schedule the side effects
|
||||||
setImmediate(() => {
|
setImmediate(() => {
|
||||||
sendRefetch(RefetchKey.CustomFields);
|
sendRefetch(RefetchKey.CustomFields);
|
||||||
notifyChanges(rundownMetadata, revision, { timer: true, external: true });
|
notifyChanges(undefined, rundownMetadata, revision, { timer: true, external: true });
|
||||||
});
|
});
|
||||||
|
|
||||||
return resultCustomFields;
|
return resultCustomFields;
|
||||||
@@ -573,7 +595,8 @@ export async function deleteCustomField(key: CustomFieldKey, projectRundowns: Pr
|
|||||||
*
|
*
|
||||||
* @private - exported for testing
|
* @private - exported for testing
|
||||||
*/
|
*/
|
||||||
export function updateRuntimeOnChange(rundownMetadata: RundownMetadata) {
|
export function updateRuntimeOnChange(rundownMetadata: RundownMetadata | null) {
|
||||||
|
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;
|
||||||
|
|
||||||
@@ -592,29 +615,40 @@ type NotifyChangesOptions = {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Notify services of changes in the rundown
|
* Notify services of changes in the rundown
|
||||||
|
* TODO: we could receive a runtime flag to call updateRuntimeOnChange
|
||||||
|
* instead of having it in every consumer
|
||||||
*/
|
*/
|
||||||
function notifyChanges(rundownMetadata: RundownMetadata, revision: number, options: NotifyChangesOptions) {
|
function notifyChanges(
|
||||||
// notify timer service of changed events
|
rundownId: string | undefined,
|
||||||
if (options.timer) {
|
rundownMetadata: RundownMetadata | null,
|
||||||
|
revision: number,
|
||||||
|
options: NotifyChangesOptions,
|
||||||
|
) {
|
||||||
|
// notify timer service of changed event
|
||||||
|
if (rundownMetadata && 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) {
|
||||||
sendRefetch(RefetchKey.Rundown, revision);
|
sendRefetch(RefetchKey.Rundown, revision, rundownId);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function isCurrentRundown(id: string) {
|
||||||
|
return id === getCurrentRundownId();
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @throws if the provided id does not exist
|
* @throws if the provided id does not exist
|
||||||
*/
|
*/
|
||||||
export async function loadRundown(id: string) {
|
export async function loadRundown(id: string) {
|
||||||
const dataProvider = getDataProvider();
|
const dataProvider = getDataProvider();
|
||||||
if (id === getCurrentRundown().id) {
|
if (isCurrentRundown(id)) {
|
||||||
return dataProvider.getProjectRundowns();
|
return dataProvider.getProjectRundowns();
|
||||||
}
|
}
|
||||||
|
|
||||||
const rundown = dataProvider.getRundown(id);
|
const rundown = dataProvider.getRundown(id);
|
||||||
const customField = dataProvider.getCustomFields();
|
const customField = dataProvider.getCustomFields();
|
||||||
await initRundown(rundown, customField);
|
await initRundown(rundown, customField);
|
||||||
@@ -637,9 +671,24 @@ export async function initRundown(
|
|||||||
updateRuntimeOnChange(rundownMetadata);
|
updateRuntimeOnChange(rundownMetadata);
|
||||||
|
|
||||||
setImmediate(() => {
|
setImmediate(() => {
|
||||||
notifyChanges(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,8 +1,6 @@
|
|||||||
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 =========================
|
||||||
|
|
||||||
@@ -11,29 +9,6 @@ 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 } = getCurrentRundown();
|
const { entries, id: currentRundownId } = 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(patchEntry);
|
await editEntry(currentRundownId, patchEntry);
|
||||||
return { payload: 'success' };
|
return { payload: 'success' };
|
||||||
},
|
},
|
||||||
/* Message Service */
|
/* Message Service */
|
||||||
|
|||||||
@@ -245,6 +245,52 @@ 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({
|
||||||
@@ -956,4 +1002,32 @@ 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 });
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -23,6 +23,7 @@ import {
|
|||||||
calculateDuration,
|
calculateDuration,
|
||||||
checkIsNow,
|
checkIsNow,
|
||||||
dayInMs,
|
dayInMs,
|
||||||
|
getExpectedEnd,
|
||||||
getExpectedStart,
|
getExpectedStart,
|
||||||
getLastEventNormal,
|
getLastEventNormal,
|
||||||
isPlaybackActive,
|
isPlaybackActive,
|
||||||
@@ -836,8 +837,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;
|
||||||
const lastEventExpectedStart = getExpectedStart(lastEvent, {
|
state.offset.expectedGroupEnd = getExpectedEnd(lastEvent, {
|
||||||
currentDay: state.rundown.currentDay!,
|
currentDay: state.rundown.currentDay ?? 0,
|
||||||
totalGap: accumulatedGap,
|
totalGap: accumulatedGap,
|
||||||
isLinkedToLoaded,
|
isLinkedToLoaded,
|
||||||
mode: offset.mode,
|
mode: offset.mode,
|
||||||
@@ -845,7 +846,6 @@ 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;
|
||||||
const expectedStart = getExpectedStart(event, {
|
state.offset.expectedRundownEnd = getExpectedEnd(event, {
|
||||||
currentDay: state.rundown.currentDay!,
|
currentDay: state.rundown.currentDay ?? 0,
|
||||||
totalGap: accumulatedGap,
|
totalGap: accumulatedGap,
|
||||||
isLinkedToLoaded,
|
isLinkedToLoaded,
|
||||||
mode: offset.mode,
|
mode: offset.mode,
|
||||||
@@ -877,7 +877,6 @@ function getExpectedTimes(state = runtimeState) {
|
|||||||
plannedStart,
|
plannedStart,
|
||||||
actualStart,
|
actualStart,
|
||||||
});
|
});
|
||||||
state.offset.expectedRundownEnd = expectedStart + event.duration;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -920,6 +919,8 @@ 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]];
|
||||||
@@ -928,7 +929,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;
|
isLinkedToLoaded = isLinkedToLoaded && entry.linkStart && !previousWasCountToEnd;
|
||||||
|
|
||||||
// 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)) {
|
||||||
@@ -942,6 +943,8 @@ export function loadGroupFlagAndEnd(
|
|||||||
foundGroupEnd = true;
|
foundGroupEnd = true;
|
||||||
state._group = { event: lastEventInGroup, isLinkedToLoaded, accumulatedGap };
|
state._group = { event: lastEventInGroup, isLinkedToLoaded, accumulatedGap };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
previousWasCountToEnd = entry.countToEnd;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -6,6 +6,51 @@ 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');
|
||||||
|
|
||||||
@@ -55,3 +100,27 @@ 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();
|
||||||
|
});
|
||||||
|
|||||||
+13
-7
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "ontime",
|
"name": "ontime",
|
||||||
"version": "4.8.0",
|
"version": "4.9.0",
|
||||||
"description": "Time keeping for live events",
|
"description": "Time keeping for live events",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"ontime",
|
"ontime",
|
||||||
@@ -17,7 +17,7 @@
|
|||||||
"license": "AGPL-3.0-only",
|
"license": "AGPL-3.0-only",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": "~22",
|
"node": "~22",
|
||||||
"pnpm": "~10"
|
"pnpm": "~11"
|
||||||
},
|
},
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
@@ -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 npx playwright test -c playwright.config.ts",
|
"e2e": "turbo run build --filter=ontime-ui && pnpm clear-temp && cross-env DEBUG=pw:webserver pnpm playwright test -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:ui": "cross-env NODE_ENV=development cross-env DEBUG=pw:webserver pnpm playwright test --ui -c playwright.config.ts",
|
||||||
"e2e:i": "npx playwright codegen",
|
"e2e:i": "pnpm 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.58.2",
|
"@playwright/test": "1.60.0",
|
||||||
"@types/node": "catalog:",
|
"@types/node": "catalog:",
|
||||||
"cross-env": "^7.0.3",
|
"cross-env": "^7.0.3",
|
||||||
"oxfmt": "^0.42.0",
|
"oxfmt": "^0.42.0",
|
||||||
@@ -51,5 +51,11 @@
|
|||||||
"turbo": "2.8.20",
|
"turbo": "2.8.20",
|
||||||
"typescript": "catalog:"
|
"typescript": "catalog:"
|
||||||
},
|
},
|
||||||
"packageManager": "pnpm@10.33.0+sha512.10568bb4a6afb58c9eb3630da90cc9516417abebd3fabbe6739f0ae795728da1491e9db5a544c76ad8eb7570f5c4bb3d6c637b2cb41bfdcdb47fa823c8649319"
|
"packageManager": "pnpm@11.1.2+sha512.415a1cc25974731e75455c1468371be74c5aa5fb7621b50d4056d222451609f11412f23fd602e6169f1e060466641f798597e1be961a10688836a67b16569499",
|
||||||
|
"devEngines": {
|
||||||
|
"runtime": {
|
||||||
|
"name": "node",
|
||||||
|
"version": "22.22.3"
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"version": "4.8.0",
|
"version": "4.9.0",
|
||||||
"name": "ontime-types",
|
"name": "ontime-types",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "./src/index.ts",
|
"main": "./src/index.ts",
|
||||||
|
|||||||
@@ -41,6 +41,7 @@ type RefetchPacket = {
|
|||||||
payload: {
|
payload: {
|
||||||
target: RefetchKey;
|
target: RefetchKey;
|
||||||
revision: MaybeNumber;
|
revision: MaybeNumber;
|
||||||
|
rundownId?: string; // undefined means refetch all rundowns
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ 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',
|
||||||
|
|||||||
@@ -80,7 +80,7 @@ export { validateEndAction, validateTimerType } from './src/validate-events/vali
|
|||||||
|
|
||||||
// feature business logic
|
// feature business logic
|
||||||
|
|
||||||
export { getExpectedStart } from './src/date-utils/getExpectedStart.js';
|
export { getExpectedStart, getExpectedEnd } from './src/date-utils/getExpected.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';
|
||||||
|
|||||||
+121
-1
@@ -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 { getExpectedStart } from './getExpectedStart';
|
import { getExpectedEnd, getExpectedStart } from './getExpected';
|
||||||
|
|
||||||
describe('getExpectedStart()', () => {
|
describe('getExpectedStart()', () => {
|
||||||
describe('Absolute offset mode', () => {
|
describe('Absolute offset mode', () => {
|
||||||
@@ -315,3 +315,123 @@ 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);
|
||||||
|
});
|
||||||
|
});
|
||||||
+36
-1
@@ -8,7 +8,6 @@ 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
|
||||||
*/
|
*/
|
||||||
@@ -60,3 +59,39 @@ 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;
|
||||||
|
}
|
||||||
Generated
+443
-774
File diff suppressed because it is too large
Load Diff
+7
-5
@@ -9,8 +9,10 @@ catalog:
|
|||||||
typescript: 6.0.2
|
typescript: 6.0.2
|
||||||
vitest: 4.0.17
|
vitest: 4.0.17
|
||||||
|
|
||||||
onlyBuiltDependencies:
|
allowBuilds:
|
||||||
- electron
|
'@parcel/watcher': true
|
||||||
- esbuild
|
'@sentry/cli': false
|
||||||
|
core-js: false
|
||||||
useNodeVersion: 22.22.2
|
electron: true
|
||||||
|
electron-winstaller: false
|
||||||
|
esbuild: true
|
||||||
|
|||||||
Reference in New Issue
Block a user