mirror of
https://github.com/cpvalente/ontime.git
synced 2026-07-26 10:38:55 +00:00
Compare commits
79 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 5cf36f049a | |||
| c6248b0c72 | |||
| 2a890cf2b3 | |||
| a8c611911d | |||
| 8363f06a5c | |||
| 5f040092cb | |||
| 347c748dd9 | |||
| f234a1f892 | |||
| 0c5e87b7e7 | |||
| 64082ceac0 | |||
| f598e8dab1 | |||
| 0c84a3ff9e | |||
| c8760b5e9c | |||
| 34360a5b8f | |||
| 5e6debcce0 | |||
| c191786e50 | |||
| 6911e37c18 | |||
| 86b2132cdc | |||
| 25f0dba83a | |||
| daa032e92c | |||
| ae65ec97d6 | |||
| e7e4302100 | |||
| 7e7d35980a | |||
| 5001dda284 | |||
| a75d35bdc0 | |||
| 2e631194e1 | |||
| f39892dc6e | |||
| 6bcfd87851 | |||
| 4addb50ca4 | |||
| 161ab3fe13 | |||
| 4f4626a163 | |||
| 82d5f02ea0 | |||
| 05aaeddf22 | |||
| 949ab2b7dc | |||
| f12d3ca59c | |||
| 42147d4d5b | |||
| 7850358039 | |||
| 52cae1e22f | |||
| 48f9fb2609 | |||
| ce8a4d230b | |||
| 1553573b94 | |||
| 41a09bf5c3 | |||
| 5dbe7afae8 | |||
| 6633cfc869 | |||
| d127367df9 | |||
| b21ec41ffd | |||
| 66292bc0cf | |||
| b946b245c2 | |||
| c238147b75 | |||
| 5f33c993f6 | |||
| 0e6d6cd416 | |||
| 199dea5df6 | |||
| 5a3ea9f7d0 | |||
| 9ae49a7175 | |||
| d30d9cfd4e | |||
| a0e7b9b665 | |||
| 1dcb7fb08d | |||
| a7e84b9903 | |||
| 3bebbf9ce9 | |||
| ab8da07518 | |||
| c8bae76121 | |||
| 2873698959 | |||
| 741ebef90e | |||
| 0741f46aca | |||
| 5a33ffad92 | |||
| 562f00dc7e | |||
| e50ab0150e | |||
| fe44b33da2 | |||
| 22e392ba9d | |||
| 4997602e9b | |||
| bdb8d4d89a | |||
| b1d5ee12e4 | |||
| a5e733246d | |||
| 1a08b39b8b | |||
| ba1c3235b3 | |||
| 7c1d2f4554 | |||
| 23a44b2f04 | |||
| 2d3c8e7eb2 | |||
| 2f138acad7 |
@@ -0,0 +1,5 @@
|
|||||||
|
# CodeGraph data files — local to each machine, not for committing.
|
||||||
|
# Ignore everything in .codegraph/ except this file itself, so transient
|
||||||
|
# files (the database, daemon.pid, sockets, logs) never show up in git.
|
||||||
|
*
|
||||||
|
!.gitignore
|
||||||
@@ -12,7 +12,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v6
|
||||||
|
|
||||||
# This step is only needed to setup the permissions to update npm as pnpm will setup the correct node version
|
# This step is only needed to setup the permissions to update npm as pnpm will setup the correct node version
|
||||||
- uses: actions/setup-node@v6
|
- uses: actions/setup-node@v6
|
||||||
@@ -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') }}
|
||||||
|
|||||||
@@ -12,16 +12,16 @@ jobs:
|
|||||||
CI: ''
|
CI: ''
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- 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') }}
|
||||||
|
|||||||
@@ -7,23 +7,23 @@ on:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build_macos:
|
build_macos:
|
||||||
runs-on: macOS-latest
|
runs-on: macOS-26
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v6
|
||||||
|
|
||||||
- uses: actions/setup-node@v6
|
- uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
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') }}
|
||||||
@@ -44,7 +44,7 @@ jobs:
|
|||||||
timeout-minutes: 60
|
timeout-minutes: 60
|
||||||
|
|
||||||
- name: Upload macOS build artifacts
|
- name: Upload macOS build artifacts
|
||||||
uses: actions/upload-artifact@v4
|
uses: actions/upload-artifact@v6
|
||||||
if: always()
|
if: always()
|
||||||
with:
|
with:
|
||||||
name: ontime-macos-build
|
name: ontime-macos-build
|
||||||
@@ -54,7 +54,7 @@ jobs:
|
|||||||
retention-days: 1
|
retention-days: 1
|
||||||
|
|
||||||
- name: Release
|
- name: Release
|
||||||
uses: softprops/action-gh-release@v1
|
uses: softprops/action-gh-release@v2
|
||||||
if: github.ref_type == 'tag'
|
if: github.ref_type == 'tag'
|
||||||
with:
|
with:
|
||||||
files: |
|
files: |
|
||||||
@@ -67,14 +67,14 @@ jobs:
|
|||||||
runs-on: windows-latest
|
runs-on: windows-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v6
|
||||||
|
|
||||||
- uses: actions/setup-node@v6
|
- uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
node-version-file: '.nvmrc'
|
node-version-file: '.nvmrc'
|
||||||
|
|
||||||
- name: Setup pnpm
|
- name: Setup pnpm
|
||||||
uses: pnpm/action-setup@v3
|
uses: pnpm/action-setup@v6
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: pnpm install --frozen-lockfile
|
run: pnpm install --frozen-lockfile
|
||||||
@@ -83,7 +83,7 @@ jobs:
|
|||||||
run: pnpm dist-win
|
run: pnpm dist-win
|
||||||
|
|
||||||
- name: Upload Windows build artifacts
|
- name: Upload Windows build artifacts
|
||||||
uses: actions/upload-artifact@v4
|
uses: actions/upload-artifact@v6
|
||||||
if: always()
|
if: always()
|
||||||
with:
|
with:
|
||||||
name: ontime-windows-build
|
name: ontime-windows-build
|
||||||
@@ -93,7 +93,7 @@ jobs:
|
|||||||
retention-days: 1
|
retention-days: 1
|
||||||
|
|
||||||
- name: Release
|
- name: Release
|
||||||
uses: softprops/action-gh-release@v1
|
uses: softprops/action-gh-release@v2
|
||||||
if: github.ref_type == 'tag'
|
if: github.ref_type == 'tag'
|
||||||
with:
|
with:
|
||||||
files: './apps/electron/dist/ontime-win64.exe'
|
files: './apps/electron/dist/ontime-win64.exe'
|
||||||
@@ -104,14 +104,14 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v6
|
||||||
|
|
||||||
- uses: actions/setup-node@v6
|
- uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
node-version-file: '.nvmrc'
|
node-version-file: '.nvmrc'
|
||||||
|
|
||||||
- name: Setup pnpm
|
- name: Setup pnpm
|
||||||
uses: pnpm/action-setup@v3
|
uses: pnpm/action-setup@v6
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: pnpm install --frozen-lockfile
|
run: pnpm install --frozen-lockfile
|
||||||
@@ -120,7 +120,7 @@ jobs:
|
|||||||
run: pnpm dist-linux
|
run: pnpm dist-linux
|
||||||
|
|
||||||
- name: Upload Linux build artifacts
|
- name: Upload Linux build artifacts
|
||||||
uses: actions/upload-artifact@v4
|
uses: actions/upload-artifact@v6
|
||||||
if: always()
|
if: always()
|
||||||
with:
|
with:
|
||||||
name: ontime-linux-build
|
name: ontime-linux-build
|
||||||
@@ -131,7 +131,7 @@ jobs:
|
|||||||
retention-days: 1
|
retention-days: 1
|
||||||
|
|
||||||
- name: Release
|
- name: Release
|
||||||
uses: softprops/action-gh-release@v1
|
uses: softprops/action-gh-release@v2
|
||||||
if: github.ref_type == 'tag'
|
if: github.ref_type == 'tag'
|
||||||
with:
|
with:
|
||||||
files: |
|
files: |
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v6
|
||||||
|
|
||||||
# This step is only needed to setup the permissions to update npm as pnpm will setup the correct node version
|
# This step is only needed to setup the permissions to update npm as pnpm will setup the correct node version
|
||||||
- uses: actions/setup-node@v6
|
- uses: actions/setup-node@v6
|
||||||
@@ -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') }}
|
||||||
|
|||||||
+19
-11
@@ -13,16 +13,20 @@ jobs:
|
|||||||
CI: ''
|
CI: ''
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- 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') }}
|
||||||
@@ -52,16 +56,20 @@ jobs:
|
|||||||
timeout-minutes: 20
|
timeout-minutes: 20
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- 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,30 +82,30 @@ 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
|
||||||
|
|
||||||
- uses: actions/upload-artifact@v4
|
- uses: actions/upload-artifact@v6
|
||||||
if: always()
|
if: always()
|
||||||
with:
|
with:
|
||||||
name: playwright-report
|
name: playwright-report
|
||||||
path: playwright-report/
|
path: playwright-report/
|
||||||
retention-days: 30
|
retention-days: 30
|
||||||
|
|
||||||
- uses: actions/upload-artifact@v4
|
- uses: actions/upload-artifact@v6
|
||||||
with:
|
with:
|
||||||
name: automated-screenshots
|
name: automated-screenshots
|
||||||
path: automated-screenshots/
|
path: automated-screenshots/
|
||||||
|
|||||||
@@ -54,3 +54,6 @@ ontime-data/
|
|||||||
|
|
||||||
# temporary write files
|
# temporary write files
|
||||||
**.tmp
|
**.tmp
|
||||||
|
|
||||||
|
# Claude Code metadata
|
||||||
|
.claude/
|
||||||
|
|||||||
+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.7.0",
|
"version": "4.11.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",
|
||||||
|
|||||||
@@ -4,9 +4,10 @@
|
|||||||
<meta charset="utf-8" />
|
<meta charset="utf-8" />
|
||||||
<base href="/" />
|
<base href="/" />
|
||||||
<link rel="icon" href="favicon.ico" />
|
<link rel="icon" href="favicon.ico" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover" />
|
||||||
<meta name="theme-color" content="#101010" />
|
<meta name="theme-color" content="#101010" />
|
||||||
<meta name="ontime" content="ontime - time keeping for live events" />
|
<meta name="ontime" content="ontime - time keeping for live events" />
|
||||||
|
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
|
||||||
<link rel="apple-touch-icon" href="ontime-logo.png" />
|
<link rel="apple-touch-icon" href="ontime-logo.png" />
|
||||||
<link rel="icon" type="image/png" href="ontime-logo.png" />
|
<link rel="icon" type="image/png" href="ontime-logo.png" />
|
||||||
<link rel="manifest" href="site.webmanifest" />
|
<link rel="manifest" href="site.webmanifest" />
|
||||||
@@ -17,6 +18,13 @@
|
|||||||
<body>
|
<body>
|
||||||
<noscript>You need to enable JavaScript to run this app.</noscript>
|
<noscript>You need to enable JavaScript to run this app.</noscript>
|
||||||
<div id="root"></div>
|
<div id="root"></div>
|
||||||
|
<script>
|
||||||
|
if (/\/timer\/?$/.test(window.location.pathname) && typeof Promise.any !== 'function') {
|
||||||
|
var b = document.querySelector('base');
|
||||||
|
var base = b ? (b.getAttribute('href') || '').replace(/\/$/, '') : '';
|
||||||
|
window.location.replace(base + '/timer-legacy' + window.location.search);
|
||||||
|
}
|
||||||
|
</script>
|
||||||
<script type="module" src="/src/index.tsx"></script>
|
<script type="module" src="/src/index.tsx"></script>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
+20
-19
@@ -1,10 +1,10 @@
|
|||||||
{
|
{
|
||||||
"name": "ontime-ui",
|
"name": "ontime-ui",
|
||||||
"version": "4.7.0",
|
"version": "4.11.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",
|
||||||
@@ -51,7 +50,8 @@
|
|||||||
"production": [
|
"production": [
|
||||||
">0.2%",
|
">0.2%",
|
||||||
"not dead",
|
"not dead",
|
||||||
"not op_mini all"
|
"not op_mini all",
|
||||||
|
"safari >= 14.1"
|
||||||
],
|
],
|
||||||
"development": [
|
"development": [
|
||||||
"last 1 chrome version",
|
"last 1 chrome version",
|
||||||
@@ -64,8 +64,10 @@
|
|||||||
"@types/qrcode": "^1.5.6",
|
"@types/qrcode": "^1.5.6",
|
||||||
"@types/react": "^19.1.12",
|
"@types/react": "^19.1.12",
|
||||||
"@types/react-dom": "^19.1.9",
|
"@types/react-dom": "^19.1.9",
|
||||||
|
"@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",
|
||||||
@@ -73,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:"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -15,5 +15,5 @@
|
|||||||
"start_url": "./",
|
"start_url": "./",
|
||||||
"display": "",
|
"display": "",
|
||||||
"theme_color": "#121212",
|
"theme_color": "#121212",
|
||||||
"background_color": "#ffffff"
|
"background_color": "#101010"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
"name": "",
|
"name": "",
|
||||||
"short_name": "",
|
"short_name": "",
|
||||||
"icons": [{ "src": "ontime-logo.png", "sizes": "295x295", "type": "image/png" }],
|
"icons": [{ "src": "ontime-logo.png", "sizes": "295x295", "type": "image/png" }],
|
||||||
"theme_color": "#2B5ABC",
|
"theme_color": "#121212",
|
||||||
"background_color": "#101010",
|
"background_color": "#101010",
|
||||||
"display": "standalone"
|
"display": "standalone"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,14 @@
|
|||||||
import axios, { AxiosResponse } from 'axios';
|
import axios, { AxiosResponse } from 'axios';
|
||||||
import { EntryId, OntimeEntry, OntimeEvent, ProjectRundownsList, Rundown, TransientEventPayload } from 'ontime-types';
|
import {
|
||||||
|
EntryId,
|
||||||
|
OntimeEntry,
|
||||||
|
OntimeEvent,
|
||||||
|
ProjectRundownsList,
|
||||||
|
RenumberCues,
|
||||||
|
Rundown,
|
||||||
|
RundownImportPayload,
|
||||||
|
TransientEventPayload,
|
||||||
|
} from 'ontime-types';
|
||||||
|
|
||||||
import { apiEntryUrl } from './constants';
|
import { apiEntryUrl } from './constants';
|
||||||
import type { RequestOptions } from './requestOptions';
|
import type { RequestOptions } from './requestOptions';
|
||||||
@@ -26,19 +35,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;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -76,6 +83,15 @@ export async function deleteRundown(rundownId: RundownId): Promise<AxiosResponse
|
|||||||
return axios.delete(`${rundownPath}/${rundownId}`);
|
return axios.delete(`${rundownPath}/${rundownId}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* HTTP request to apply an imported rundown using a merge strategy or into a new rundown
|
||||||
|
*/
|
||||||
|
export async function importRundownWithOptions(
|
||||||
|
payload: RundownImportPayload,
|
||||||
|
): Promise<AxiosResponse<ProjectRundownsList>> {
|
||||||
|
return axios.post(`${rundownPath}/import`, payload);
|
||||||
|
}
|
||||||
|
|
||||||
// #endregion operations on project rundowns ======================
|
// #endregion operations on project rundowns ======================
|
||||||
// #region operations on rundown entries ==========================
|
// #region operations on rundown entries ==========================
|
||||||
|
|
||||||
@@ -111,6 +127,13 @@ export async function putBatchEditEvents(rundownId: RundownId, data: BatchEditEn
|
|||||||
return axios.put(`${rundownPath}/${rundownId}/batch`, data);
|
return axios.put(`${rundownPath}/${rundownId}/batch`, data);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* HTTP request to renumber cues for multiple events
|
||||||
|
*/
|
||||||
|
export function patchRenumberCues(rundownId: RundownId, data: RenumberCues): Promise<AxiosResponse<Rundown>> {
|
||||||
|
return axios.patch(`${rundownPath}/${rundownId}/renumber`, data);
|
||||||
|
}
|
||||||
|
|
||||||
export type ReorderEntry = {
|
export type ReorderEntry = {
|
||||||
entryId: EntryId;
|
entryId: EntryId;
|
||||||
destinationId: EntryId;
|
destinationId: EntryId;
|
||||||
@@ -182,3 +205,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'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
// skipcq: JS-C1003 - sentry does not expose itself as an ES Module.
|
// skipcq: JS-C1003 - sentry does not expose itself as an ES Module.
|
||||||
import * as Sentry from '@sentry/react';
|
import * as Sentry from '@sentry/react';
|
||||||
/* eslint-disable react/destructuring-assignment */
|
|
||||||
import React from 'react';
|
import React from 'react';
|
||||||
|
|
||||||
import { hasConnected, reconnectAttempts } from '../../../common/utils/socket';
|
|
||||||
import { runtimeStore } from '../../stores/runtime';
|
import { runtimeStore } from '../../stores/runtime';
|
||||||
|
import { getConnectionState, getReconnectAttempts } from '../../utils/socket';
|
||||||
|
|
||||||
import style from './ErrorBoundary.module.scss';
|
import style from './ErrorBoundary.module.scss';
|
||||||
|
|
||||||
@@ -37,7 +36,7 @@ class ErrorBoundary extends React.Component {
|
|||||||
scope.setExtras({
|
scope.setExtras({
|
||||||
error,
|
error,
|
||||||
store: appState,
|
store: appState,
|
||||||
hasSocket: { hasConnected, reconnectAttempts },
|
hasSocket: { hasConnected: getConnectionState(), reconnectAttempts: getReconnectAttempts() },
|
||||||
});
|
});
|
||||||
const eventId = Sentry.captureException(error);
|
const eventId = Sentry.captureException(error);
|
||||||
this.setState({ eventId, info });
|
this.setState({ eventId, info });
|
||||||
|
|||||||
@@ -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,
|
||||||
|
|||||||
@@ -0,0 +1,14 @@
|
|||||||
|
.kbd {
|
||||||
|
display: inline-block;
|
||||||
|
min-width: 1.5rem;
|
||||||
|
padding: 0.0625rem 0.375rem;
|
||||||
|
border-radius: 2px;
|
||||||
|
background-color: $gray-1100;
|
||||||
|
color: $ui-white;
|
||||||
|
box-shadow: 0 0 3px rgba(0, 0, 0, 0.4);
|
||||||
|
font-family: monospace;
|
||||||
|
font-size: calc(1rem - 4px);
|
||||||
|
line-height: 1.5;
|
||||||
|
text-align: center;
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
import { PropsWithChildren } from 'react';
|
||||||
|
|
||||||
|
import style from './Kbd.module.scss';
|
||||||
|
|
||||||
|
export default function Kbd({ children }: PropsWithChildren) {
|
||||||
|
return <kbd className={style.kbd}>{children}</kbd>;
|
||||||
|
}
|
||||||
@@ -20,7 +20,7 @@
|
|||||||
.wide {
|
.wide {
|
||||||
top: 4vh;
|
top: 4vh;
|
||||||
min-width: min(1280px, 96vw);
|
min-width: min(1280px, 96vw);
|
||||||
max-width: min(1600px, 96vw);
|
max-width: min(1800px, 98vw);
|
||||||
height: 88vh;
|
height: 88vh;
|
||||||
max-height: 88vh;
|
max-height: 88vh;
|
||||||
display: flex;
|
display: flex;
|
||||||
|
|||||||
@@ -38,8 +38,6 @@ $progress-bar-br: 3px;
|
|||||||
.multiprogress-bar__indicator-bar {
|
.multiprogress-bar__indicator-bar {
|
||||||
background-color: var(--background-color-override, $ui-black);
|
background-color: var(--background-color-override, $ui-black);
|
||||||
opacity: 0.8;
|
opacity: 0.8;
|
||||||
transition: 1s linear;
|
|
||||||
transition-property: width;
|
|
||||||
|
|
||||||
.multiprogress-bar--ignore-css-override & {
|
.multiprogress-bar--ignore-css-override & {
|
||||||
background-color: $ui-black;
|
background-color: $ui-black;
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
import { MaybeNumber } from 'ontime-types';
|
import { MaybeNumber } from 'ontime-types';
|
||||||
|
|
||||||
|
import { useAnimatedProgress } from '../../hooks/useAnimatedProgress';
|
||||||
import { getProgress } from '../../utils/getProgress';
|
import { getProgress } from '../../utils/getProgress';
|
||||||
import { cx } from '../../utils/styleUtils';
|
import { cx } from '../../utils/styleUtils';
|
||||||
|
|
||||||
@@ -34,7 +35,7 @@ export default function MultiPartProgressBar(props: MultiPartProgressBar) {
|
|||||||
className = '',
|
className = '',
|
||||||
} = props;
|
} = props;
|
||||||
|
|
||||||
const percentRemaining = 100 - getProgress(now, complete);
|
const percentRemaining = 100 - useAnimatedProgress(now, complete);
|
||||||
const dangerWidth = danger ? 100 - getProgress(danger, complete) : 0;
|
const dangerWidth = danger ? 100 - getProgress(danger, complete) : 0;
|
||||||
const warningWidth = warning ? 100 - dangerWidth - getProgress(warning, complete) : 0;
|
const warningWidth = warning ? 100 - dangerWidth - getProgress(warning, complete) : 0;
|
||||||
const isOvertime = now !== null && now < 0;
|
const isOvertime = now !== null && now < 0;
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ import { useLocation } from 'react-router';
|
|||||||
import { isLocalhost, supportsFullscreen } from '../../../externals';
|
import { isLocalhost, supportsFullscreen } from '../../../externals';
|
||||||
import { canUseWakeLock, useKeepAwakeOptions } from '../../../features/keep-awake/useWakeLock';
|
import { canUseWakeLock, useKeepAwakeOptions } from '../../../features/keep-awake/useWakeLock';
|
||||||
import { navigatorConstants } from '../../../viewerConfig';
|
import { navigatorConstants } from '../../../viewerConfig';
|
||||||
|
import useUrlPresets from '../../hooks-query/useUrlPresets';
|
||||||
import { useIsSmallScreen } from '../../hooks/useIsSmallScreen';
|
import { useIsSmallScreen } from '../../hooks/useIsSmallScreen';
|
||||||
import { useClientStore } from '../../stores/clientStore';
|
import { useClientStore } from '../../stores/clientStore';
|
||||||
import { useViewOptionsStore } from '../../stores/viewOptions';
|
import { useViewOptionsStore } from '../../stores/viewOptions';
|
||||||
@@ -105,6 +106,8 @@ function NavigationMenu({ isOpen, onClose }: NavigationMenuProps) {
|
|||||||
{route.label}
|
{route.label}
|
||||||
</ClientLink>
|
</ClientLink>
|
||||||
))}
|
))}
|
||||||
|
|
||||||
|
<PresetNavigation isSmallScreen={isSmallScreen} onClose={onClose} />
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
{isLocalhost && (
|
{isLocalhost && (
|
||||||
@@ -117,3 +120,27 @@ function NavigationMenu({ isOpen, onClose }: NavigationMenuProps) {
|
|||||||
</Dialog.Root>
|
</Dialog.Root>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function PresetNavigation({ isSmallScreen, onClose }: { isSmallScreen: boolean; onClose: () => void }) {
|
||||||
|
const location = useLocation();
|
||||||
|
const { data: urlPresets } = useUrlPresets();
|
||||||
|
const navPresets = urlPresets.filter((preset) => preset.enabled && preset.displayInNav);
|
||||||
|
|
||||||
|
if (navPresets.length === 0) return null;
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
<hr className={style.separator} />
|
||||||
|
{navPresets.map((preset) => (
|
||||||
|
<ClientLink
|
||||||
|
key={preset.alias}
|
||||||
|
to={`preset/${preset.alias}`}
|
||||||
|
current={location.pathname === `/preset/${preset.alias}`}
|
||||||
|
postAction={isSmallScreen ? onClose : undefined}
|
||||||
|
>
|
||||||
|
{preset.alias}
|
||||||
|
</ClientLink>
|
||||||
|
))}
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
import { useDisclosure, useHotkeys } from '@mantine/hooks';
|
import { useDisclosure, useHotkeys } from '@mantine/hooks';
|
||||||
import { memo } from 'react';
|
import { memo } from 'react';
|
||||||
|
import { useSearchParams } from 'react-router';
|
||||||
|
|
||||||
|
import { hasCustomParams, useSavedViewParams } from '../../stores/savedViewParams';
|
||||||
import { useViewParamsEditorStore } from '../view-params-editor/viewParamsEditor.store';
|
import { useViewParamsEditorStore } from '../view-params-editor/viewParamsEditor.store';
|
||||||
import FloatingNavigation from './floating-navigation/FloatingNavigation';
|
import FloatingNavigation from './floating-navigation/FloatingNavigation';
|
||||||
import NavigationMenu from './NavigationMenu';
|
import NavigationMenu from './NavigationMenu';
|
||||||
@@ -17,6 +19,9 @@ export default memo(ViewNavigationMenu);
|
|||||||
function ViewNavigationMenu({ isNavigationLocked, suppressSettings }: ViewNavigationMenuProps) {
|
function ViewNavigationMenu({ isNavigationLocked, suppressSettings }: ViewNavigationMenuProps) {
|
||||||
const [isMenuOpen, menuHandler] = useDisclosure();
|
const [isMenuOpen, menuHandler] = useDisclosure();
|
||||||
const { open: showEditFormDrawer } = useViewParamsEditorStore();
|
const { open: showEditFormDrawer } = useViewParamsEditorStore();
|
||||||
|
const [searchParams] = useSearchParams();
|
||||||
|
const savedParams = useSavedViewParams((store) => store.params);
|
||||||
|
const hasSavedChanges = hasCustomParams(searchParams) || Object.keys(savedParams).length > 0;
|
||||||
|
|
||||||
useHotkeys([
|
useHotkeys([
|
||||||
[
|
[
|
||||||
@@ -46,6 +51,7 @@ function ViewNavigationMenu({ isNavigationLocked, suppressSettings }: ViewNaviga
|
|||||||
<FloatingNavigation
|
<FloatingNavigation
|
||||||
toggleMenu={isNavigationLocked ? undefined : menuHandler.toggle}
|
toggleMenu={isNavigationLocked ? undefined : menuHandler.toggle}
|
||||||
toggleSettings={suppressSettings ? undefined : showEditFormDrawer}
|
toggleSettings={suppressSettings ? undefined : showEditFormDrawer}
|
||||||
|
hasSavedChanges={hasSavedChanges}
|
||||||
/>
|
/>
|
||||||
{!isNavigationLocked && <NavigationMenu isOpen={isMenuOpen} onClose={menuHandler.close} />}
|
{!isNavigationLocked && <NavigationMenu isOpen={isMenuOpen} onClose={menuHandler.close} />}
|
||||||
</>
|
</>
|
||||||
|
|||||||
+26
-1
@@ -1,4 +1,29 @@
|
|||||||
.linkIcon {
|
.trailing {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.5rem;
|
||||||
margin-left: auto;
|
margin-left: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.linkIcon {
|
||||||
@include rotate-fourty-five;
|
@include rotate-fourty-five;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.indicator {
|
||||||
|
width: 0.5rem;
|
||||||
|
height: 0.5rem;
|
||||||
|
border-radius: 50%;
|
||||||
|
background-color: $active-indicator;
|
||||||
|
pointer-events: none;
|
||||||
|
flex-shrink: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.clear {
|
||||||
|
opacity: 0.6;
|
||||||
|
transition: opacity $transition-time-action;
|
||||||
|
|
||||||
|
&:hover,
|
||||||
|
&:focus-visible {
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,9 +1,17 @@
|
|||||||
import { PropsWithChildren } from 'react';
|
import { MouseEvent, PropsWithChildren } from 'react';
|
||||||
import { IoArrowUp } from 'react-icons/io5';
|
import { IoArrowUp, IoCloseOutline } from 'react-icons/io5';
|
||||||
import { useNavigate } from 'react-router';
|
import { useLocation, useNavigate, useSearchParams } from 'react-router';
|
||||||
|
|
||||||
import { useElectronEvent } from '../../../hooks/useElectronEvent';
|
import { useElectronEvent } from '../../../hooks/useElectronEvent';
|
||||||
|
import {
|
||||||
|
hasCustomParams,
|
||||||
|
reservedParams,
|
||||||
|
stripReservedParams,
|
||||||
|
useSavedViewParams,
|
||||||
|
} from '../../../stores/savedViewParams';
|
||||||
import { handleLinks } from '../../../utils/linkUtils';
|
import { handleLinks } from '../../../utils/linkUtils';
|
||||||
|
import IconButton from '../../buttons/IconButton';
|
||||||
|
import Tooltip from '../../tooltip/Tooltip';
|
||||||
import NavigationMenuItem from '../navigation-menu-item/NavigationMenuItem';
|
import NavigationMenuItem from '../navigation-menu-item/NavigationMenuItem';
|
||||||
|
|
||||||
import style from './ClientLink.module.scss';
|
import style from './ClientLink.module.scss';
|
||||||
@@ -16,32 +24,104 @@ interface ClientLinkProps {
|
|||||||
|
|
||||||
export default function ClientLink({ current, to, postAction, children }: PropsWithChildren<ClientLinkProps>) {
|
export default function ClientLink({ current, to, postAction, children }: PropsWithChildren<ClientLinkProps>) {
|
||||||
const { isElectron } = useElectronEvent();
|
const { isElectron } = useElectronEvent();
|
||||||
const navigate = useNavigate();
|
|
||||||
|
|
||||||
if (isElectron) {
|
if (isElectron) {
|
||||||
return (
|
return (
|
||||||
<NavigationMenuItem
|
<ElectronNavigationItem current={current} to={to} postAction={postAction}>
|
||||||
active={current}
|
|
||||||
onClick={() => {
|
|
||||||
handleLinks(to);
|
|
||||||
postAction?.();
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
{children}
|
{children}
|
||||||
<IoArrowUp className={style.linkIcon} />
|
</ElectronNavigationItem>
|
||||||
</NavigationMenuItem>
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<NavigationMenuItem
|
<BrowserNavigationItem current={current} to={to} postAction={postAction}>
|
||||||
active={current}
|
|
||||||
onClick={() => {
|
|
||||||
navigate(`/${to}`);
|
|
||||||
postAction?.();
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
{children}
|
{children}
|
||||||
|
</BrowserNavigationItem>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function ElectronNavigationItem({ current, to, postAction, children }: PropsWithChildren<ClientLinkProps>) {
|
||||||
|
const navigateToLink = () => {
|
||||||
|
handleLinks(to);
|
||||||
|
postAction?.();
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<NavigationMenuItem active={current} onClick={navigateToLink}>
|
||||||
|
{children}
|
||||||
|
<span className={style.trailing}>
|
||||||
|
<IoArrowUp className={style.linkIcon} />
|
||||||
|
</span>
|
||||||
|
</NavigationMenuItem>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function BrowserNavigationItem({ current, to, postAction, children }: PropsWithChildren<ClientLinkProps>) {
|
||||||
|
const navigate = useNavigate();
|
||||||
|
const location = useLocation();
|
||||||
|
const [searchParams, setSearchParams] = useSearchParams();
|
||||||
|
const { params: savedParams, save, clear } = useSavedViewParams();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Save the params of the view we are leaving and resolve the destination,
|
||||||
|
* restoring any params previously saved for the target view.
|
||||||
|
*/
|
||||||
|
const resolveDestination = () => {
|
||||||
|
const currentView = location.pathname.replace(/^\//, '');
|
||||||
|
save(currentView, stripReservedParams(location.search));
|
||||||
|
const restored = savedParams[to];
|
||||||
|
return `${to}${restored ? `?${restored}` : ''}`;
|
||||||
|
};
|
||||||
|
|
||||||
|
const isCustomised = current ? hasCustomParams(searchParams) : Boolean(savedParams[to]);
|
||||||
|
|
||||||
|
const navigateToLink = () => {
|
||||||
|
const destination = resolveDestination();
|
||||||
|
navigate(`/${destination}`);
|
||||||
|
postAction?.();
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clear the saved settings for this route without navigating to it.
|
||||||
|
* When it is the current view, also reset the live URL to its defaults.
|
||||||
|
*/
|
||||||
|
const clearViewSettings = (event: MouseEvent) => {
|
||||||
|
event.stopPropagation();
|
||||||
|
clear(to);
|
||||||
|
|
||||||
|
// if mounted, clear the URL params
|
||||||
|
if (current) {
|
||||||
|
const preserved = new URLSearchParams();
|
||||||
|
reservedParams.forEach((key) => {
|
||||||
|
const value = searchParams.get(key);
|
||||||
|
if (value !== null) preserved.set(key, value);
|
||||||
|
});
|
||||||
|
setSearchParams(preserved);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<NavigationMenuItem active={current} onClick={navigateToLink}>
|
||||||
|
{children}
|
||||||
|
{isCustomised && (
|
||||||
|
<span className={style.trailing}>
|
||||||
|
<span className={style.indicator} aria-hidden data-testid='client-link__saved-indicator' />
|
||||||
|
<Tooltip
|
||||||
|
text='Reset to default'
|
||||||
|
render={
|
||||||
|
<IconButton
|
||||||
|
variant='ghosted-white'
|
||||||
|
size='small'
|
||||||
|
className={style.clear}
|
||||||
|
aria-label='Reset to default'
|
||||||
|
onClick={clearViewSettings}
|
||||||
|
/>
|
||||||
|
}
|
||||||
|
>
|
||||||
|
<IoCloseOutline />
|
||||||
|
</Tooltip>
|
||||||
|
</span>
|
||||||
|
)}
|
||||||
</NavigationMenuItem>
|
</NavigationMenuItem>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
+16
@@ -22,3 +22,19 @@
|
|||||||
top: 0;
|
top: 0;
|
||||||
z-index: $zindex-nav;
|
z-index: $zindex-nav;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.buttonWithIndicator {
|
||||||
|
position: relative;
|
||||||
|
display: inline-flex;
|
||||||
|
}
|
||||||
|
|
||||||
|
.indicator {
|
||||||
|
position: absolute;
|
||||||
|
top: -0.15rem;
|
||||||
|
right: -0.15rem;
|
||||||
|
width: 0.6rem;
|
||||||
|
height: 0.6rem;
|
||||||
|
border-radius: 50%;
|
||||||
|
background-color: $active-indicator;
|
||||||
|
pointer-events: none;
|
||||||
|
}
|
||||||
|
|||||||
+14
-10
@@ -9,9 +9,10 @@ import style from './FloatingNavigation.module.scss';
|
|||||||
interface FloatingNavigationProps {
|
interface FloatingNavigationProps {
|
||||||
toggleMenu?: () => void;
|
toggleMenu?: () => void;
|
||||||
toggleSettings?: () => void;
|
toggleSettings?: () => void;
|
||||||
|
hasSavedChanges?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export default function FloatingNavigation({ toggleMenu, toggleSettings }: FloatingNavigationProps) {
|
export default function FloatingNavigation({ toggleMenu, toggleSettings, hasSavedChanges }: FloatingNavigationProps) {
|
||||||
const isButtonShown = useFadeOutOnInactivity(true);
|
const isButtonShown = useFadeOutOnInactivity(true);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
@@ -20,15 +21,18 @@ export default function FloatingNavigation({ toggleMenu, toggleSettings }: Float
|
|||||||
className={cx([style.fadeable, style.buttonContainer, !isButtonShown && style.hidden])}
|
className={cx([style.fadeable, style.buttonContainer, !isButtonShown && style.hidden])}
|
||||||
>
|
>
|
||||||
{toggleMenu && (
|
{toggleMenu && (
|
||||||
<IconButton
|
<div className={style.buttonWithIndicator}>
|
||||||
variant='subtle-white'
|
<IconButton
|
||||||
size='xlarge'
|
variant='subtle-white'
|
||||||
onClick={toggleMenu}
|
size='xlarge'
|
||||||
aria-label='toggle menu'
|
onClick={toggleMenu}
|
||||||
data-testid='navigation__toggle-menu'
|
aria-label='toggle menu'
|
||||||
>
|
data-testid='navigation__toggle-menu'
|
||||||
<IoApps />
|
>
|
||||||
</IconButton>
|
<IoApps />
|
||||||
|
</IconButton>
|
||||||
|
{hasSavedChanges && <span className={style.indicator} data-testid='navigation__saved-indicator' />}
|
||||||
|
</div>
|
||||||
)}
|
)}
|
||||||
{toggleSettings && (
|
{toggleSettings && (
|
||||||
<IconButton
|
<IconButton
|
||||||
|
|||||||
@@ -14,6 +14,4 @@ $progress-bar-br: 3px;
|
|||||||
.progress-bar__indicator {
|
.progress-bar__indicator {
|
||||||
height: $progress-bar-size;
|
height: $progress-bar-size;
|
||||||
background-color: var(--timer-progress-override, $accent-color);
|
background-color: var(--timer-progress-override, $accent-color);
|
||||||
transition: 1s linear;
|
|
||||||
transition-property: width;
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import { MaybeNumber } from 'ontime-types';
|
import { MaybeNumber } from 'ontime-types';
|
||||||
|
|
||||||
import { getProgress } from '../../utils/getProgress';
|
import { useAnimatedProgress } from '../../hooks/useAnimatedProgress';
|
||||||
|
|
||||||
import './ProgressBar.scss';
|
import './ProgressBar.scss';
|
||||||
|
|
||||||
@@ -12,7 +12,7 @@ interface ProgressBarProps {
|
|||||||
|
|
||||||
export default function ProgressBar(props: ProgressBarProps) {
|
export default function ProgressBar(props: ProgressBarProps) {
|
||||||
const { current, duration, className } = props;
|
const { current, duration, className } = props;
|
||||||
const progress = getProgress(current, duration);
|
const progress = useAnimatedProgress(current, duration);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className={`progress-bar__bg ${className}`}>
|
<div className={`progress-bar__bg ${className}`}>
|
||||||
|
|||||||
@@ -4,7 +4,9 @@
|
|||||||
color: $white-10;
|
color: $white-10;
|
||||||
|
|
||||||
.empty {
|
.empty {
|
||||||
width: 100%;
|
display: block;
|
||||||
|
width: min(100%, 24rem);
|
||||||
|
margin-inline: auto;
|
||||||
opacity: 0.8;
|
opacity: 0.8;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -13,6 +15,6 @@
|
|||||||
margin-inline: auto;
|
margin-inline: auto;
|
||||||
font-weight: 600;
|
font-weight: 600;
|
||||||
font-size: 2em;
|
font-size: 2em;
|
||||||
max-width: 600px;
|
max-width: min(100%, 600px);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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>
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ import { useSearchParams } from 'react-router';
|
|||||||
|
|
||||||
import useViewSettings from '../../hooks-query/useViewSettings';
|
import useViewSettings from '../../hooks-query/useViewSettings';
|
||||||
import { useIsSmallScreen } from '../../hooks/useIsSmallScreen';
|
import { useIsSmallScreen } from '../../hooks/useIsSmallScreen';
|
||||||
|
import { useSavedViewParams } from '../../stores/savedViewParams';
|
||||||
import Button from '../buttons/Button';
|
import Button from '../buttons/Button';
|
||||||
import IconButton from '../buttons/IconButton';
|
import IconButton from '../buttons/IconButton';
|
||||||
import Info from '../info/Info';
|
import Info from '../info/Info';
|
||||||
@@ -27,6 +28,7 @@ function ViewParamsEditor({ target, viewOptions }: EditFormDrawerProps) {
|
|||||||
const [searchParams, setSearchParams] = useSearchParams();
|
const [searchParams, setSearchParams] = useSearchParams();
|
||||||
const { data: viewSettings } = useViewSettings();
|
const { data: viewSettings } = useViewSettings();
|
||||||
const { isOpen, close } = useViewParamsEditorStore();
|
const { isOpen, close } = useViewParamsEditorStore();
|
||||||
|
const clearSavedParams = useSavedViewParams((store) => store.clear);
|
||||||
const isSmallScreen = useIsSmallScreen();
|
const isSmallScreen = useIsSmallScreen();
|
||||||
|
|
||||||
const getPreservedParams = () => getPreservedSearchParams(searchParams, viewOptions);
|
const getPreservedParams = () => getPreservedSearchParams(searchParams, viewOptions);
|
||||||
@@ -36,6 +38,7 @@ function ViewParamsEditor({ target, viewOptions }: EditFormDrawerProps) {
|
|||||||
};
|
};
|
||||||
|
|
||||||
const resetParams = () => {
|
const resetParams = () => {
|
||||||
|
clearSavedParams(target);
|
||||||
setSearchParams(getPreservedParams());
|
setSearchParams(getPreservedParams());
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@@ -64,8 +64,8 @@ function SectionContents({ options, collapsed }: SectionContentsProps) {
|
|||||||
function HiddenContents({ options }: { options: ParamField[] }) {
|
function HiddenContents({ options }: { options: ParamField[] }) {
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
{options.map((option, index) => {
|
{options.map((option) => {
|
||||||
return <ParamInput key={option.title + index} paramField={option} />;
|
return <ParamInput key={option.id} paramField={option} />;
|
||||||
})}
|
})}
|
||||||
</>
|
</>
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -26,3 +26,14 @@ export const showLeadingZeros: ParamField = {
|
|||||||
type: 'boolean',
|
type: 'boolean',
|
||||||
defaultValue: false,
|
defaultValue: false,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export type TimeOptions = {
|
||||||
|
timeformat: string | null;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Helper to get value of 'timeformat' from either source, prioritizing defaultValues
|
||||||
|
*/
|
||||||
|
export function getTimeOptionsFromParams(searchParams: URLSearchParams, defaultValues?: URLSearchParams) {
|
||||||
|
return defaultValues?.get('timeformat') ?? searchParams.get('timeformat');
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,16 +1,16 @@
|
|||||||
import { useQuery } from '@tanstack/react-query';
|
import { useQuery } from '@tanstack/react-query';
|
||||||
import { langEn } from 'ontime-types';
|
import { langEn } from 'ontime-types';
|
||||||
|
import { MILLIS_PER_HOUR } from 'ontime-utils';
|
||||||
|
|
||||||
import { getUserTranslation } from '../../common/api/assets';
|
import { getUserTranslation } from '../../common/api/assets';
|
||||||
import { TRANSLATION } from '../../common/api/constants';
|
import { TRANSLATION } from '../../common/api/constants';
|
||||||
import { queryRefetchIntervalSlow } from '../../ontimeConfig';
|
|
||||||
|
|
||||||
export function useCustomTranslation() {
|
export function useCustomTranslation() {
|
||||||
const { data, status, refetch } = useQuery({
|
const { data, status, refetch } = useQuery({
|
||||||
queryKey: TRANSLATION,
|
queryKey: TRANSLATION,
|
||||||
queryFn: ({ signal }) => getUserTranslation({ signal }),
|
queryFn: ({ signal }) => getUserTranslation({ signal }),
|
||||||
placeholderData: (previousData, _previousQuery) => previousData,
|
placeholderData: (previousData, _previousQuery) => previousData,
|
||||||
refetchInterval: queryRefetchIntervalSlow,
|
staleTime: MILLIS_PER_HOUR,
|
||||||
});
|
});
|
||||||
return { data: data ?? langEn, status, refetch };
|
return { data: data ?? langEn, status, refetch };
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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],
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
import { MaybeNumber, Playback } from 'ontime-types';
|
||||||
|
import { useEffect, useRef, useState } from 'react';
|
||||||
|
|
||||||
|
import { getProgress } from '../utils/getProgress';
|
||||||
|
import { usePlayback } from './useSocket';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the live completion percentage (0–100) of a countdown, interpolated locally.
|
||||||
|
*/
|
||||||
|
export function useAnimatedProgress(current: MaybeNumber, duration: MaybeNumber): number {
|
||||||
|
const playback = usePlayback();
|
||||||
|
const isRunning = playback === Playback.Play || playback === Playback.Roll;
|
||||||
|
|
||||||
|
const baseline = useRef({ current, at: performance.now() });
|
||||||
|
const [, setTick] = useState(0);
|
||||||
|
|
||||||
|
// there is only something to animate while a running timer is counting down towards 0
|
||||||
|
const shouldAnimate = isRunning && current !== null && current > 0 && duration !== null;
|
||||||
|
|
||||||
|
// re-anchor to the authoritative value whenever the server pushes a new timer update
|
||||||
|
useEffect(() => {
|
||||||
|
baseline.current = { current, at: performance.now() };
|
||||||
|
}, [current, duration, playback]);
|
||||||
|
|
||||||
|
// while counting down, re-render every animation frame so the derived progress stays smooth
|
||||||
|
useEffect(() => {
|
||||||
|
if (!shouldAnimate) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
let frame = requestAnimationFrame(function tick() {
|
||||||
|
setTick((value) => value + 1);
|
||||||
|
frame = requestAnimationFrame(tick);
|
||||||
|
});
|
||||||
|
return () => cancelAnimationFrame(frame);
|
||||||
|
}, [shouldAnimate]);
|
||||||
|
|
||||||
|
// derive from the anchor plus elapsed time at render; frozen to the anchor when not running
|
||||||
|
const anchored = baseline.current.current;
|
||||||
|
const value = isRunning && anchored !== null ? anchored - (performance.now() - baseline.current.at) : anchored;
|
||||||
|
return getProgress(value, duration);
|
||||||
|
}
|
||||||
@@ -1,7 +1,6 @@
|
|||||||
import { useMutation, useQueryClient } from '@tanstack/react-query';
|
import { useMutation, useQueryClient } from '@tanstack/react-query';
|
||||||
import {
|
import {
|
||||||
EntryId,
|
EntryId,
|
||||||
InsertOptions,
|
|
||||||
MaybeString,
|
MaybeString,
|
||||||
OntimeDelay,
|
OntimeDelay,
|
||||||
OntimeEntry,
|
OntimeEntry,
|
||||||
@@ -16,6 +15,7 @@ import {
|
|||||||
TimeStrategy,
|
TimeStrategy,
|
||||||
isOntimeEvent,
|
isOntimeEvent,
|
||||||
isOntimeGroup,
|
isOntimeGroup,
|
||||||
|
isOntimeMilestone,
|
||||||
} from 'ontime-types';
|
} from 'ontime-types';
|
||||||
import {
|
import {
|
||||||
MILLIS_PER_SECOND,
|
MILLIS_PER_SECOND,
|
||||||
@@ -41,6 +41,7 @@ import {
|
|||||||
patchReorderEntry,
|
patchReorderEntry,
|
||||||
postAddEntry,
|
postAddEntry,
|
||||||
postCloneEntry,
|
postCloneEntry,
|
||||||
|
patchRenumberCues,
|
||||||
putBatchEditEvents,
|
putBatchEditEvents,
|
||||||
putEditEntry,
|
putEditEntry,
|
||||||
requestApplyDelay,
|
requestApplyDelay,
|
||||||
@@ -58,13 +59,26 @@ export type EventOptions = Partial<{
|
|||||||
before: MaybeString;
|
before: MaybeString;
|
||||||
// options of entries of type OntimeEvent
|
// options of entries of type OntimeEvent
|
||||||
linkPrevious: boolean;
|
linkPrevious: boolean;
|
||||||
|
/** the timing reference for the new entry, usually the same as after */
|
||||||
lastEventId: MaybeString;
|
lastEventId: MaybeString;
|
||||||
}>;
|
}>;
|
||||||
|
|
||||||
|
type ClientInsertOptions = {
|
||||||
|
after?: EntryId;
|
||||||
|
before?: EntryId;
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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,
|
||||||
@@ -74,15 +88,16 @@ export const useEntryActions = () => {
|
|||||||
defaultDangerTime,
|
defaultDangerTime,
|
||||||
defaultTimerType,
|
defaultTimerType,
|
||||||
defaultEndAction,
|
defaultEndAction,
|
||||||
|
inheritGroupColour,
|
||||||
} = 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
|
||||||
@@ -110,7 +125,7 @@ export const useEntryActions = () => {
|
|||||||
* @private
|
* @private
|
||||||
*/
|
*/
|
||||||
const { mutateAsync: addEntryMutation } = useMutation({
|
const { mutateAsync: addEntryMutation } = useMutation({
|
||||||
mutationFn: ([rundownId, entry]: [string, PatchWithId & InsertOptions]) => postAddEntry(rundownId, entry),
|
mutationFn: ([rundownId, entry]: [string, PatchWithId & ClientInsertOptions]) => postAddEntry(rundownId, entry),
|
||||||
onMutate: async ([_rundownId, entry]) => {
|
onMutate: async ([_rundownId, entry]) => {
|
||||||
const queryKey = resolveCurrentRundownQueryKey();
|
const queryKey = resolveCurrentRundownQueryKey();
|
||||||
await queryClient.cancelQueries({ queryKey });
|
await queryClient.cancelQueries({ queryKey });
|
||||||
@@ -139,8 +154,9 @@ export const useEntryActions = () => {
|
|||||||
addToRundown(
|
addToRundown(
|
||||||
newRundown,
|
newRundown,
|
||||||
optimisticEntry,
|
optimisticEntry,
|
||||||
afterId,
|
|
||||||
parent ? (newRundown.entries[parent.id] as OntimeGroup) : null,
|
parent ? (newRundown.entries[parent.id] as OntimeGroup) : null,
|
||||||
|
afterId,
|
||||||
|
entry.before ?? null,
|
||||||
);
|
);
|
||||||
|
|
||||||
queryClient.setQueryData<Rundown>(queryKey, newRundown);
|
queryClient.setQueryData<Rundown>(queryKey, newRundown);
|
||||||
@@ -183,7 +199,7 @@ export const useEntryActions = () => {
|
|||||||
throw new Error('Rundown not initialised');
|
throw new Error('Rundown not initialised');
|
||||||
}
|
}
|
||||||
|
|
||||||
const newEntry: PatchWithId & InsertOptions = { ...entry, id: generateId() };
|
const newEntry: PatchWithId & ClientInsertOptions = { ...entry, id: generateId() };
|
||||||
|
|
||||||
// handle adding options that concern all event types
|
// handle adding options that concern all event types
|
||||||
if (options?.after) {
|
if (options?.after) {
|
||||||
@@ -195,8 +211,8 @@ export const useEntryActions = () => {
|
|||||||
|
|
||||||
// ************* CHECK OPTIONS specific to events
|
// ************* CHECK OPTIONS specific to events
|
||||||
if (isOntimeEvent(newEntry)) {
|
if (isOntimeEvent(newEntry)) {
|
||||||
|
// last event id is the timing reference of the previous OntimeEvent in rundown
|
||||||
if (options?.lastEventId) {
|
if (options?.lastEventId) {
|
||||||
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- we know this is a value
|
|
||||||
const previousEvent = rundownData.entries[options?.lastEventId];
|
const previousEvent = rundownData.entries[options?.lastEventId];
|
||||||
if (isOntimeEvent(previousEvent)) {
|
if (isOntimeEvent(previousEvent)) {
|
||||||
newEntry.timeStart = previousEvent.timeEnd;
|
newEntry.timeStart = previousEvent.timeEnd;
|
||||||
@@ -231,6 +247,14 @@ export const useEntryActions = () => {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (inheritGroupColour && (isOntimeEvent(newEntry) || isOntimeMilestone(newEntry)) && !newEntry.colour) {
|
||||||
|
const parentId = resolveInsertParent(rundownData, newEntry);
|
||||||
|
const maybeParent = parentId ? rundownData.entries[parentId] : null;
|
||||||
|
if (maybeParent && isOntimeGroup(maybeParent)) {
|
||||||
|
newEntry.colour = maybeParent.colour;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
await addEntryMutation([rundownId, newEntry]);
|
await addEntryMutation([rundownId, newEntry]);
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
@@ -246,6 +270,7 @@ export const useEntryActions = () => {
|
|||||||
defaultTimerType,
|
defaultTimerType,
|
||||||
defaultEndAction,
|
defaultEndAction,
|
||||||
defaultTimeStrategy,
|
defaultTimeStrategy,
|
||||||
|
inheritGroupColour,
|
||||||
addEntryMutation,
|
addEntryMutation,
|
||||||
],
|
],
|
||||||
);
|
);
|
||||||
@@ -265,7 +290,7 @@ export const useEntryActions = () => {
|
|||||||
* Clone an entry
|
* Clone an entry
|
||||||
*/
|
*/
|
||||||
const clone = useCallback(
|
const clone = useCallback(
|
||||||
async (entryId: EntryId, options?: InsertOptions) => {
|
async (entryId: EntryId, options?: ClientInsertOptions) => {
|
||||||
try {
|
try {
|
||||||
const rundownId = getCurrentRundownData()?.id;
|
const rundownId = getCurrentRundownData()?.id;
|
||||||
if (!rundownId) {
|
if (!rundownId) {
|
||||||
@@ -523,6 +548,39 @@ export const useEntryActions = () => {
|
|||||||
[batchUpdateEventsMutation, getCurrentRundownData],
|
[batchUpdateEventsMutation, getCurrentRundownData],
|
||||||
);
|
);
|
||||||
|
|
||||||
|
const { mutateAsync: renumberCuesMutation } = useMutation({
|
||||||
|
mutationFn: ([rundownId, body]: Parameters<typeof patchRenumberCues>) => patchRenumberCues(rundownId, body),
|
||||||
|
onMutate: async () => {
|
||||||
|
const queryKey = resolveCurrentRundownQueryKey();
|
||||||
|
await queryClient.cancelQueries({ queryKey });
|
||||||
|
const previousRundown = queryClient.getQueryData<Rundown>(queryKey);
|
||||||
|
return { previousRundown, queryKey };
|
||||||
|
},
|
||||||
|
onSuccess: (response, _variables, context) => {
|
||||||
|
if (!response.data || !context?.queryKey) return;
|
||||||
|
const updatedRundown = response.data;
|
||||||
|
queryClient.setQueryData<Rundown>(context.queryKey, updatedRundown);
|
||||||
|
},
|
||||||
|
onError: (_error, _vars, context) => {
|
||||||
|
if (context?.previousRundown) queryClient.setQueryData<Rundown>(context.queryKey, context.previousRundown);
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const renumberCues = useCallback(
|
||||||
|
async (eventIds: EntryId[], prefix: string, start: string, increment: string) => {
|
||||||
|
const rundown = getCurrentRundownData();
|
||||||
|
const rundownId = rundown?.id;
|
||||||
|
if (!rundownId) throw new Error('Rundown not initialized');
|
||||||
|
try {
|
||||||
|
await renumberCuesMutation([rundownId, { ids: eventIds, prefix, start, increment }]);
|
||||||
|
} catch (error) {
|
||||||
|
logAxiosError('Error renumbering cues', error);
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
},
|
||||||
|
[getCurrentRundownData, renumberCuesMutation],
|
||||||
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Calls mutation to delete an entry
|
* Calls mutation to delete an entry
|
||||||
* @private
|
* @private
|
||||||
@@ -947,6 +1005,7 @@ export const useEntryActions = () => {
|
|||||||
groupEntries,
|
groupEntries,
|
||||||
move,
|
move,
|
||||||
reorderEntry,
|
reorderEntry,
|
||||||
|
renumberCues,
|
||||||
swapEvents,
|
swapEvents,
|
||||||
updateEntry,
|
updateEntry,
|
||||||
updateTimer,
|
updateTimer,
|
||||||
@@ -963,12 +1022,13 @@ export const useEntryActions = () => {
|
|||||||
groupEntries,
|
groupEntries,
|
||||||
move,
|
move,
|
||||||
reorderEntry,
|
reorderEntry,
|
||||||
|
renumberCues,
|
||||||
swapEvents,
|
swapEvents,
|
||||||
updateEntry,
|
updateEntry,
|
||||||
updateTimer,
|
updateTimer,
|
||||||
],
|
],
|
||||||
);
|
);
|
||||||
};
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Utility to optimistically delete entries from client cache
|
* Utility to optimistically delete entries from client cache
|
||||||
@@ -1003,7 +1063,7 @@ function optimisticDeleteEntries(entryIds: EntryId[], rundown: Rundown) {
|
|||||||
/**
|
/**
|
||||||
* Utility to create an optimistic entry for immediate cache insertion
|
* Utility to create an optimistic entry for immediate cache insertion
|
||||||
*/
|
*/
|
||||||
function createOptimisticEntry(payload: PatchWithId & InsertOptions): OntimeEntry {
|
function createOptimisticEntry(payload: PatchWithId & ClientInsertOptions): OntimeEntry {
|
||||||
const { after: _after, before: _before, ...entryData } = payload;
|
const { after: _after, before: _before, ...entryData } = payload;
|
||||||
const id = entryData.id;
|
const id = entryData.id;
|
||||||
let parent: EntryId | null = null;
|
let parent: EntryId | null = null;
|
||||||
|
|||||||
@@ -139,6 +139,17 @@ export const setEventPlayback = {
|
|||||||
pause: () => sendSocket('pause', undefined),
|
pause: () => sendSocket('pause', undefined),
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export const useTimerProgress = createSelector((state: RuntimeStore) => ({
|
||||||
|
playback: state.timer.playback,
|
||||||
|
phase: state.timer.phase,
|
||||||
|
addedTime: state.timer.addedTime,
|
||||||
|
secondaryTimer: state.timer.secondaryTimer,
|
||||||
|
current: state.timer.current,
|
||||||
|
expectedFinish: state.timer.expectedFinish,
|
||||||
|
startedAt: state.timer.startedAt,
|
||||||
|
isCountToEnd: state.eventNow?.countToEnd ?? false,
|
||||||
|
}));
|
||||||
|
|
||||||
export const useTimer = createSelector((state: RuntimeStore) => ({
|
export const useTimer = createSelector((state: RuntimeStore) => ({
|
||||||
...state.timer,
|
...state.timer,
|
||||||
}));
|
}));
|
||||||
|
|||||||
@@ -0,0 +1,87 @@
|
|||||||
|
import { hasCustomParams, stripReservedParams, useSavedViewParams } from '../savedViewParams';
|
||||||
|
|
||||||
|
describe('savedViewParams store', () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
useSavedViewParams.getState().clearAll();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('saves and restores params per view', () => {
|
||||||
|
useSavedViewParams.getState().save('timer', 'hideSeconds=true');
|
||||||
|
useSavedViewParams.getState().save('backstage', 'showProgress=false');
|
||||||
|
|
||||||
|
expect(useSavedViewParams.getState().params.timer).toBe('hideSeconds=true');
|
||||||
|
expect(useSavedViewParams.getState().params.backstage).toBe('showProgress=false');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('overwrites the saved params for a view on subsequent saves', () => {
|
||||||
|
useSavedViewParams.getState().save('timer', 'hideSeconds=true');
|
||||||
|
useSavedViewParams.getState().save('timer', 'hideSeconds=false');
|
||||||
|
|
||||||
|
expect(useSavedViewParams.getState().params.timer).toBe('hideSeconds=false');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not store an entry for an empty search string', () => {
|
||||||
|
useSavedViewParams.getState().save('timer', '');
|
||||||
|
|
||||||
|
expect(useSavedViewParams.getState().params).toEqual({});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('removes a previously saved entry when saved with an empty search string', () => {
|
||||||
|
useSavedViewParams.getState().save('timer', 'hideSeconds=true');
|
||||||
|
useSavedViewParams.getState().save('timer', '');
|
||||||
|
|
||||||
|
expect(useSavedViewParams.getState().params).toEqual({});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('ignores empty view keys', () => {
|
||||||
|
useSavedViewParams.getState().save('', 'hideSeconds=true');
|
||||||
|
|
||||||
|
expect(useSavedViewParams.getState().params).toEqual({});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('clears the saved params for a single view without touching others', () => {
|
||||||
|
useSavedViewParams.getState().save('timer', 'hideSeconds=true');
|
||||||
|
useSavedViewParams.getState().save('backstage', 'showProgress=false');
|
||||||
|
useSavedViewParams.getState().clear('timer');
|
||||||
|
|
||||||
|
expect(useSavedViewParams.getState().params).toEqual({ backstage: 'showProgress=false' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('is a no-op when clearing a view without saved params', () => {
|
||||||
|
useSavedViewParams.getState().save('backstage', 'showProgress=false');
|
||||||
|
useSavedViewParams.getState().clear('timer');
|
||||||
|
|
||||||
|
expect(useSavedViewParams.getState().params).toEqual({ backstage: 'showProgress=false' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('clears all saved params', () => {
|
||||||
|
useSavedViewParams.getState().save('timer', 'hideSeconds=true');
|
||||||
|
useSavedViewParams.getState().clearAll();
|
||||||
|
|
||||||
|
expect(useSavedViewParams.getState().params).toEqual({});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('stripReservedParams', () => {
|
||||||
|
it('removes reserved auth/preset params while keeping view customisation', () => {
|
||||||
|
expect(stripReservedParams('hideSeconds=true&token=abc&n=1&alias=my')).toBe('hideSeconds=true');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns an empty string when only reserved params are present', () => {
|
||||||
|
expect(stripReservedParams('token=abc&n=1&alias=my')).toBe('');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('hasCustomParams', () => {
|
||||||
|
it('is true when a non-reserved param is present', () => {
|
||||||
|
expect(hasCustomParams(new URLSearchParams('hideSeconds=true&token=abc'))).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('is false when only reserved params are present', () => {
|
||||||
|
expect(hasCustomParams(new URLSearchParams('token=abc&n=1&alias=my'))).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('is false when there are no params', () => {
|
||||||
|
expect(hasCustomParams(new URLSearchParams(''))).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -12,8 +12,10 @@ type EditorSettingsStore = {
|
|||||||
defaultDangerTime: string;
|
defaultDangerTime: string;
|
||||||
defaultTimerType: TimerType;
|
defaultTimerType: TimerType;
|
||||||
defaultEndAction: EndAction;
|
defaultEndAction: EndAction;
|
||||||
|
inheritGroupColour: boolean;
|
||||||
setDefaultDuration: (defaultDuration: string) => void;
|
setDefaultDuration: (defaultDuration: string) => void;
|
||||||
setLinkPrevious: (linkPrevious: boolean) => void;
|
setLinkPrevious: (linkPrevious: boolean) => void;
|
||||||
|
setInheritGroupColour: (inheritGroupColour: boolean) => void;
|
||||||
setTimeStrategy: (timeStrategy: TimeStrategy) => void;
|
setTimeStrategy: (timeStrategy: TimeStrategy) => void;
|
||||||
setWarnTime: (warnTime: string) => void;
|
setWarnTime: (warnTime: string) => void;
|
||||||
setDangerTime: (dangerTime: string) => void;
|
setDangerTime: (dangerTime: string) => void;
|
||||||
@@ -29,6 +31,7 @@ export const editorSettingsDefaults = {
|
|||||||
dangerTime: '00:01:00', // 60000 same as backend
|
dangerTime: '00:01:00', // 60000 same as backend
|
||||||
timerType: TimerType.CountDown,
|
timerType: TimerType.CountDown,
|
||||||
endAction: EndAction.None,
|
endAction: EndAction.None,
|
||||||
|
inheritGroupColour: false,
|
||||||
};
|
};
|
||||||
|
|
||||||
enum EditorSettingsKeys {
|
enum EditorSettingsKeys {
|
||||||
@@ -39,6 +42,7 @@ enum EditorSettingsKeys {
|
|||||||
DefaultDangerTime = 'ontime-default-danger-time',
|
DefaultDangerTime = 'ontime-default-danger-time',
|
||||||
DefaultTimerType = 'ontime-default-timer-type',
|
DefaultTimerType = 'ontime-default-timer-type',
|
||||||
DefaultEndAction = 'ontime-default-end-action',
|
DefaultEndAction = 'ontime-default-end-action',
|
||||||
|
InheritGroupColour = 'ontime-inherit-group-colour',
|
||||||
}
|
}
|
||||||
|
|
||||||
export const useEditorSettings = create<EditorSettingsStore>((set) => {
|
export const useEditorSettings = create<EditorSettingsStore>((set) => {
|
||||||
@@ -59,6 +63,10 @@ export const useEditorSettings = create<EditorSettingsStore>((set) => {
|
|||||||
localStorage.getItem(EditorSettingsKeys.DefaultEndAction),
|
localStorage.getItem(EditorSettingsKeys.DefaultEndAction),
|
||||||
editorSettingsDefaults.endAction,
|
editorSettingsDefaults.endAction,
|
||||||
),
|
),
|
||||||
|
inheritGroupColour: booleanFromLocalStorage(
|
||||||
|
EditorSettingsKeys.InheritGroupColour,
|
||||||
|
editorSettingsDefaults.inheritGroupColour,
|
||||||
|
),
|
||||||
|
|
||||||
setDefaultDuration: (defaultDuration) =>
|
setDefaultDuration: (defaultDuration) =>
|
||||||
set(() => {
|
set(() => {
|
||||||
@@ -97,5 +105,10 @@ export const useEditorSettings = create<EditorSettingsStore>((set) => {
|
|||||||
localStorage.setItem(EditorSettingsKeys.DefaultEndAction, String(defaultEndAction));
|
localStorage.setItem(EditorSettingsKeys.DefaultEndAction, String(defaultEndAction));
|
||||||
return { defaultEndAction };
|
return { defaultEndAction };
|
||||||
}),
|
}),
|
||||||
|
setInheritGroupColour: (inheritGroupColour) =>
|
||||||
|
set(() => {
|
||||||
|
localStorage.setItem(EditorSettingsKeys.InheritGroupColour, String(inheritGroupColour));
|
||||||
|
return { inheritGroupColour };
|
||||||
|
}),
|
||||||
};
|
};
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -0,0 +1,62 @@
|
|||||||
|
import { create } from 'zustand';
|
||||||
|
|
||||||
|
// params that are auth/preset markers, not user view customisation (see common/utils/urlPresets.ts)
|
||||||
|
export const reservedParams = new Set(['token', 'n', 'alias']);
|
||||||
|
|
||||||
|
interface SavedViewParamsStore {
|
||||||
|
params: Record<string, string>; // view key (e.g. "timer") -> search string without leading "?"
|
||||||
|
save: (view: string, search: string) => void;
|
||||||
|
clear: (view: string) => void;
|
||||||
|
clearAll: () => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remembers the last view parameters used for each view so they can be
|
||||||
|
* restored when the user navigates back to that view through the menu.
|
||||||
|
* In-memory only: persists across SPA navigation, resets on a full page reload.
|
||||||
|
*/
|
||||||
|
export const useSavedViewParams = create<SavedViewParamsStore>((set) => ({
|
||||||
|
params: {},
|
||||||
|
save: (view, search) =>
|
||||||
|
set((state) => {
|
||||||
|
// ignore empty view keys and do not store empty entries, so the
|
||||||
|
// "saved changes" indicator only reflects genuine customisation
|
||||||
|
if (!view) return state;
|
||||||
|
const params = { ...state.params };
|
||||||
|
if (search) {
|
||||||
|
params[view] = search;
|
||||||
|
} else {
|
||||||
|
delete params[view];
|
||||||
|
}
|
||||||
|
return { params };
|
||||||
|
}),
|
||||||
|
clear: (view) =>
|
||||||
|
set((state) => {
|
||||||
|
if (!state.params[view]) return state;
|
||||||
|
const params = { ...state.params };
|
||||||
|
delete params[view];
|
||||||
|
return { params };
|
||||||
|
}),
|
||||||
|
clearAll: () => set({ params: {} }),
|
||||||
|
}));
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes reserved (auth/preset) params from a search string, keeping only
|
||||||
|
* genuine view customisation.
|
||||||
|
*/
|
||||||
|
export function stripReservedParams(search: string): string {
|
||||||
|
const sp = new URLSearchParams(search);
|
||||||
|
reservedParams.forEach((key) => sp.delete(key));
|
||||||
|
return sp.toString();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the search params contain any genuine view customisation,
|
||||||
|
* ignoring reserved params.
|
||||||
|
*/
|
||||||
|
export function hasCustomParams(searchParams: URLSearchParams): boolean {
|
||||||
|
for (const key of searchParams.keys()) {
|
||||||
|
if (!reservedParams.has(key)) return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
import { linkToOtherHost } from '../linkUtils';
|
import { hostToBaseUrl, linkToOtherHost } from '../linkUtils';
|
||||||
|
|
||||||
describe('linkToOTherHost', () => {
|
describe('linkToOTherHost', () => {
|
||||||
it('should handle electron links', () => {
|
it('should handle electron links', () => {
|
||||||
@@ -22,3 +22,18 @@ describe('linkToOTherHost', () => {
|
|||||||
expect(destination).toBe('https://app.getontime.no/user-hash/path');
|
expect(destination).toBe('https://app.getontime.no/user-hash/path');
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe('hostToBaseUrl', () => {
|
||||||
|
it('uses http when the page is plain http', () => {
|
||||||
|
expect(hostToBaseUrl('192.168.10.166', 4001, 'http://localhost:4001')).toBe('http://192.168.10.166:4001');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('keeps https when the page reaches the server over TLS on the same port', () => {
|
||||||
|
expect(hostToBaseUrl('192.168.10.166', 4001, 'https://localhost:4001')).toBe('https://192.168.10.166:4001');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('falls back to http when the page is https on a different port (TLS proxy)', () => {
|
||||||
|
// the raw server port does not speak TLS, an https link to it would fail
|
||||||
|
expect(hostToBaseUrl('192.168.10.166', 4001, 'https://ontime.example.com')).toBe('http://192.168.10.166:4001');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|||||||
@@ -0,0 +1,25 @@
|
|||||||
|
import { describe, expect, it } from 'vitest';
|
||||||
|
|
||||||
|
import { removeFileExtension } from '../uploadUtils';
|
||||||
|
|
||||||
|
describe('removeFileExtension()', () => {
|
||||||
|
it('removes a trailing extension', () => {
|
||||||
|
expect(removeFileExtension('show.xlsx')).toBe('show');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('only removes the last extension', () => {
|
||||||
|
expect(removeFileExtension('my.show.xlsx')).toBe('my.show');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns the name unchanged when there is no extension', () => {
|
||||||
|
expect(removeFileExtension('rundown')).toBe('rundown');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not treat a leading dot as an extension', () => {
|
||||||
|
expect(removeFileExtension('.gitignore')).toBe('.gitignore');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('handles an empty string', () => {
|
||||||
|
expect(removeFileExtension('')).toBe('');
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -37,6 +37,16 @@ describe('getRouteFromPreset()', () => {
|
|||||||
alias: 'demopage',
|
alias: 'demopage',
|
||||||
target: OntimeView.Timer,
|
target: OntimeView.Timer,
|
||||||
search: 'user=guest',
|
search: 'user=guest',
|
||||||
|
displayInNav: false,
|
||||||
|
options: {},
|
||||||
|
},
|
||||||
|
];
|
||||||
|
const disabledPresets: URLPreset[] = [
|
||||||
|
{
|
||||||
|
enabled: false,
|
||||||
|
alias: 'demopage',
|
||||||
|
target: OntimeView.Timer,
|
||||||
|
search: 'user=guest',
|
||||||
options: {},
|
options: {},
|
||||||
},
|
},
|
||||||
];
|
];
|
||||||
@@ -47,6 +57,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 +106,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', () => {
|
||||||
@@ -90,6 +120,7 @@ describe('getRouteFromPreset()', () => {
|
|||||||
alias: 'cuesheet-4685d6',
|
alias: 'cuesheet-4685d6',
|
||||||
target: OntimeView.Cuesheet,
|
target: OntimeView.Cuesheet,
|
||||||
search: '',
|
search: '',
|
||||||
|
displayInNav: false,
|
||||||
options: {
|
options: {
|
||||||
read: 'full',
|
read: 'full',
|
||||||
write: '-',
|
write: '-',
|
||||||
@@ -102,6 +133,7 @@ describe('getRouteFromPreset()', () => {
|
|||||||
alias: 'cuesheet-basic',
|
alias: 'cuesheet-basic',
|
||||||
target: OntimeView.Cuesheet,
|
target: OntimeView.Cuesheet,
|
||||||
search: '',
|
search: '',
|
||||||
|
displayInNav: false,
|
||||||
},
|
},
|
||||||
];
|
];
|
||||||
const cuesheetPresetWithNavLock: URLPreset[] = [
|
const cuesheetPresetWithNavLock: URLPreset[] = [
|
||||||
@@ -110,6 +142,7 @@ describe('getRouteFromPreset()', () => {
|
|||||||
alias: 'cuesheet-locked',
|
alias: 'cuesheet-locked',
|
||||||
target: OntimeView.Cuesheet,
|
target: OntimeView.Cuesheet,
|
||||||
search: 'n=1',
|
search: 'n=1',
|
||||||
|
displayInNav: false,
|
||||||
},
|
},
|
||||||
];
|
];
|
||||||
|
|
||||||
@@ -191,6 +224,7 @@ describe('generateUrlPresetOptions', () => {
|
|||||||
target: 'timer',
|
target: 'timer',
|
||||||
search: 'param1=value1¶m2=value2',
|
search: 'param1=value1¶m2=value2',
|
||||||
enabled: true,
|
enabled: true,
|
||||||
|
displayInNav: false,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
[
|
[
|
||||||
@@ -202,6 +236,7 @@ describe('generateUrlPresetOptions', () => {
|
|||||||
target: 'timer',
|
target: 'timer',
|
||||||
search: 'param1=value1¶m2=value2',
|
search: 'param1=value1¶m2=value2',
|
||||||
enabled: true,
|
enabled: true,
|
||||||
|
displayInNav: false,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
[
|
[
|
||||||
@@ -213,6 +248,7 @@ describe('generateUrlPresetOptions', () => {
|
|||||||
target: 'timer',
|
target: 'timer',
|
||||||
search: 'param1=value1¶m2=value2',
|
search: 'param1=value1¶m2=value2',
|
||||||
enabled: true,
|
enabled: true,
|
||||||
|
displayInNav: false,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
[
|
[
|
||||||
@@ -224,6 +260,7 @@ describe('generateUrlPresetOptions', () => {
|
|||||||
target: 'timer',
|
target: 'timer',
|
||||||
search: 'param1=value1¶m2=value2',
|
search: 'param1=value1¶m2=value2',
|
||||||
enabled: true,
|
enabled: true,
|
||||||
|
displayInNav: false,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
])('should generate URL preset options for %s', (_description, alias, url, expected) => {
|
])('should generate URL preset options for %s', (_description, alias, url, expected) => {
|
||||||
|
|||||||
@@ -37,7 +37,12 @@ export function handleLinks(
|
|||||||
event?.preventDefault();
|
event?.preventDefault();
|
||||||
|
|
||||||
const destination = new URL(externalServerUrl);
|
const destination = new URL(externalServerUrl);
|
||||||
destination.pathname = externalBaseURI ? `${externalBaseURI}/${location}` : location;
|
// split off any query string so it is not encoded into the pathname
|
||||||
|
const [pathname, search] = location.split('?');
|
||||||
|
destination.pathname = externalBaseURI ? `${externalBaseURI}/${pathname}` : pathname;
|
||||||
|
if (search) {
|
||||||
|
destination.search = search;
|
||||||
|
}
|
||||||
openLink(destination.toString());
|
openLink(destination.toString());
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -54,3 +59,17 @@ export function linkToOtherHost(
|
|||||||
}
|
}
|
||||||
return destination.toString();
|
return destination.toString();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Builds a base URL for reaching the Ontime server on a given network interface.
|
||||||
|
* The Ontime server itself only speaks HTTP, so we only keep https when the page
|
||||||
|
* already reaches the server over TLS on that same port (eg. a proxy in front of it);
|
||||||
|
* any other explicit server port gets http.
|
||||||
|
* externalServerUrl is used for testing
|
||||||
|
*/
|
||||||
|
export function hostToBaseUrl(host: string, port: number, externalServerUrl: string = serverURL): string {
|
||||||
|
const page = new URL(externalServerUrl);
|
||||||
|
const pagePort = page.port === '' ? (page.protocol === 'https:' ? 443 : 80) : Number(page.port);
|
||||||
|
const scheme = page.protocol === 'https:' && pagePort === port ? 'https' : 'http';
|
||||||
|
return `${scheme}://${host}:${port}`;
|
||||||
|
}
|
||||||
|
|||||||
@@ -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';
|
||||||
@@ -51,8 +50,10 @@ const socketConfig = {
|
|||||||
offlineAttemptsThreshold: 2, // when we consider the client disconnected
|
offlineAttemptsThreshold: 2, // when we consider the client disconnected
|
||||||
} as const;
|
} as const;
|
||||||
|
|
||||||
export let hasConnected = false;
|
export const getConnectionState = () => hasConnected;
|
||||||
export let reconnectAttempts = 0;
|
export const getReconnectAttempts = () => reconnectAttempts;
|
||||||
|
let hasConnected = false;
|
||||||
|
let reconnectAttempts = 0;
|
||||||
|
|
||||||
export const connectSocket = () => {
|
export const connectSocket = () => {
|
||||||
websocket = new WebSocket(websocketUrl);
|
websocket = new WebSocket(websocketUrl);
|
||||||
@@ -179,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();
|
||||||
@@ -194,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:
|
||||||
@@ -212,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;
|
||||||
@@ -230,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>(
|
||||||
|
|||||||
@@ -1,9 +1,11 @@
|
|||||||
import { MaybeNumber, OntimeEvent, Settings, TimeFormat } from 'ontime-types';
|
import { MaybeNumber, MaybeString, OntimeEvent, Settings, TimeFormat } from 'ontime-types';
|
||||||
import {
|
import {
|
||||||
MILLIS_PER_HOUR,
|
MILLIS_PER_HOUR,
|
||||||
MILLIS_PER_MINUTE,
|
MILLIS_PER_MINUTE,
|
||||||
MILLIS_PER_SECOND,
|
MILLIS_PER_SECOND,
|
||||||
|
dayInMs,
|
||||||
formatFromMillis,
|
formatFromMillis,
|
||||||
|
getExpectedEnd,
|
||||||
getExpectedStart,
|
getExpectedStart,
|
||||||
} from 'ontime-utils';
|
} from 'ontime-utils';
|
||||||
|
|
||||||
@@ -29,6 +31,11 @@ export function nowInMillis(): number {
|
|||||||
return elapsed;
|
return elapsed;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function normaliseWallClock(time: number): number {
|
||||||
|
const timeOfDay = time % dayInMs;
|
||||||
|
return timeOfDay < 0 ? timeOfDay + dayInMs : timeOfDay;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @description Resolves format from url and store
|
* @description Resolves format from url and store
|
||||||
* @return {string|null} A format string like "hh:mm:ss a" or null
|
* @return {string|null} A format string like "hh:mm:ss a" or null
|
||||||
@@ -75,8 +82,9 @@ function resolveTimeFormat(fallback12: string, fallback24: string): string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type FormatOptions = {
|
type FormatOptions = {
|
||||||
format12: string;
|
format12?: string;
|
||||||
format24: string;
|
format24?: string;
|
||||||
|
override?: MaybeString;
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -97,7 +105,7 @@ export const formatTime = (
|
|||||||
return '...';
|
return '...';
|
||||||
}
|
}
|
||||||
|
|
||||||
const timeFormat = resolver(options?.format12 ?? FORMAT_12, options?.format24 ?? FORMAT_24);
|
const timeFormat = options?.override ?? resolver(options?.format12 ?? FORMAT_12, options?.format24 ?? FORMAT_24);
|
||||||
const display = formatFromMillis(Math.abs(milliseconds), timeFormat);
|
const display = formatFromMillis(Math.abs(milliseconds), timeFormat);
|
||||||
|
|
||||||
const isNegative = milliseconds < 0;
|
const isNegative = milliseconds < 0;
|
||||||
@@ -179,15 +187,13 @@ export function getExpectedTimesFromExtendedEvent(
|
|||||||
...state,
|
...state,
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
const expectedEnd = getExpectedEnd(event, expectedStart, state.currentDay);
|
||||||
const plannedEnd = event.timeStart + event.duration + event.delay;
|
const plannedEnd = event.timeStart + event.duration + event.delay;
|
||||||
|
|
||||||
return {
|
return {
|
||||||
expectedStart,
|
expectedStart,
|
||||||
timeToStart: expectedStart - state.clock,
|
timeToStart: expectedStart - state.clock,
|
||||||
expectedEnd: event.countToEnd
|
expectedEnd,
|
||||||
? Math.max(expectedStart + event.duration, plannedEnd)
|
|
||||||
: expectedStart + event.duration,
|
|
||||||
plannedEnd,
|
plannedEnd,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -38,6 +38,18 @@ export function validateProjectFile(file: File) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes a trailing file extension from a file name (e.g. "show.xlsx" -> "show")
|
||||||
|
* A leading dot (dotfiles like ".gitignore") is not treated as an extension
|
||||||
|
*/
|
||||||
|
export function removeFileExtension(fileName: string): string {
|
||||||
|
const lastDot = fileName.lastIndexOf('.');
|
||||||
|
if (lastDot <= 0) {
|
||||||
|
return fileName;
|
||||||
|
}
|
||||||
|
return fileName.slice(0, lastDot);
|
||||||
|
}
|
||||||
|
|
||||||
export function isExcelFile(file: File | null) {
|
export function isExcelFile(file: File | null) {
|
||||||
return file?.name.endsWith('.xlsx');
|
return file?.name.endsWith('.xlsx');
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -194,6 +194,7 @@ export function generateUrlPresetOptions(alias: string, userUrl: string): URLPre
|
|||||||
target: path,
|
target: path,
|
||||||
search: url.searchParams.toString(),
|
search: url.searchParams.toString(),
|
||||||
enabled: true,
|
enabled: true,
|
||||||
|
displayInNav: false,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -204,7 +205,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';
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ export const apiRepoLatest = 'https://api.github.com/repos/cpvalente/ontime/rele
|
|||||||
export const websiteUrl = 'https://www.getontime.no';
|
export const websiteUrl = 'https://www.getontime.no';
|
||||||
export const discordUrl = 'https://discord.com/invite/eje3CSUEXm';
|
export const discordUrl = 'https://discord.com/invite/eje3CSUEXm';
|
||||||
export const subredditUrl = 'https://www.reddit.com/r/ontimeapp/';
|
export const subredditUrl = 'https://www.reddit.com/r/ontimeapp/';
|
||||||
|
export const youtubeUrl = 'https://www.youtube.com/@ontimeapp';
|
||||||
|
|
||||||
export const documentationUrl = 'https://docs.getontime.no';
|
export const documentationUrl = 'https://docs.getontime.no';
|
||||||
export const customFieldsDocsUrl = 'https://docs.getontime.no/features/custom-fields/';
|
export const customFieldsDocsUrl = 'https://docs.getontime.no/features/custom-fields/';
|
||||||
|
|||||||
@@ -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}>
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ $inner-padding: 1rem;
|
|||||||
.section {
|
.section {
|
||||||
position: relative;
|
position: relative;
|
||||||
margin-top: 2rem;
|
margin-top: 2rem;
|
||||||
max-width: 850px;
|
max-width: 1024px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.indent {
|
.indent {
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ import {
|
|||||||
githubUrl,
|
githubUrl,
|
||||||
subredditUrl,
|
subredditUrl,
|
||||||
websiteUrl,
|
websiteUrl,
|
||||||
|
youtubeUrl,
|
||||||
} from '../../../../externals';
|
} from '../../../../externals';
|
||||||
import * as Panel from '../../panel-utils/PanelUtils';
|
import * as Panel from '../../panel-utils/PanelUtils';
|
||||||
import AppVersion from './AppVersion';
|
import AppVersion from './AppVersion';
|
||||||
@@ -38,6 +39,7 @@ export default function AboutPanel() {
|
|||||||
<ExternalLink href={documentationUrl}>Read the docs</ExternalLink>
|
<ExternalLink href={documentationUrl}>Read the docs</ExternalLink>
|
||||||
<ExternalLink href={githubUrl}>Follow the project on GitHub</ExternalLink>
|
<ExternalLink href={githubUrl}>Follow the project on GitHub</ExternalLink>
|
||||||
<ExternalLink href={discordUrl}>Discord server</ExternalLink>
|
<ExternalLink href={discordUrl}>Discord server</ExternalLink>
|
||||||
|
<ExternalLink href={youtubeUrl}>YouTube channel</ExternalLink>
|
||||||
<ExternalLink href={subredditUrl}>Subreddit</ExternalLink>
|
<ExternalLink href={subredditUrl}>Subreddit</ExternalLink>
|
||||||
</Panel.Section>
|
</Panel.Section>
|
||||||
</>
|
</>
|
||||||
|
|||||||
@@ -293,8 +293,9 @@ export default function AutomationForm({ automation, onClose }: AutomationFormPr
|
|||||||
<h3>Outputs</h3>
|
<h3>Outputs</h3>
|
||||||
<Info>
|
<Info>
|
||||||
Automation outputs can be used to send data from Ontime to external software <br />
|
Automation outputs can be used to send data from Ontime to external software <br />
|
||||||
or to change properties of Ontime itself.
|
or to change properties of Ontime itself. <br /> <br />
|
||||||
<ExternalLink href={integrationsDocsUrl}>See the documentation for templates</ExternalLink>
|
Use Ontime runtime data in these fields with template strings. Type {'{{'} to see autocomplete, or{' '}
|
||||||
|
<ExternalLink href={integrationsDocsUrl}>read the docs</ExternalLink>
|
||||||
</Info>
|
</Info>
|
||||||
|
|
||||||
{fieldOutputs.map((output, index) => {
|
{fieldOutputs.map((output, index) => {
|
||||||
@@ -341,12 +342,17 @@ export default function AutomationForm({ automation, onClose }: AutomationFormPr
|
|||||||
</label>
|
</label>
|
||||||
<label>
|
<label>
|
||||||
Address
|
Address
|
||||||
<Input {...register(`outputs.${index}.address`)} fluid placeholder='/cue/start' />
|
<TemplateInput
|
||||||
|
{...register(`outputs.${index}.address`)}
|
||||||
|
value={output.address}
|
||||||
|
fluid
|
||||||
|
placeholder='/cue/start'
|
||||||
|
/>
|
||||||
<Panel.Error>{rowErrors?.address?.message}</Panel.Error>
|
<Panel.Error>{rowErrors?.address?.message}</Panel.Error>
|
||||||
</label>
|
</label>
|
||||||
<label>
|
<label>
|
||||||
Arguments
|
Arguments
|
||||||
<TemplateInput {...register(`outputs.${index}.args`)} value={output.args} placeholder='1' />
|
<TemplateInput {...register(`outputs.${index}.args`)} value={output.args} fluid placeholder='1' />
|
||||||
<Panel.Error>{rowErrors?.args?.message}</Panel.Error>
|
<Panel.Error>{rowErrors?.args?.message}</Panel.Error>
|
||||||
</label>
|
</label>
|
||||||
<div>
|
<div>
|
||||||
@@ -376,7 +382,7 @@ export default function AutomationForm({ automation, onClose }: AutomationFormPr
|
|||||||
<div className={style.httpSection}>
|
<div className={style.httpSection}>
|
||||||
<label>
|
<label>
|
||||||
Target URL
|
Target URL
|
||||||
<Input
|
<TemplateInput
|
||||||
{...register(`outputs.${index}.url`, {
|
{...register(`outputs.${index}.url`, {
|
||||||
required: { value: true, message: 'Required field' },
|
required: { value: true, message: 'Required field' },
|
||||||
pattern: {
|
pattern: {
|
||||||
@@ -384,6 +390,7 @@ export default function AutomationForm({ automation, onClose }: AutomationFormPr
|
|||||||
message: 'HTTP messages should target http:// or https://',
|
message: 'HTTP messages should target http:// or https://',
|
||||||
},
|
},
|
||||||
})}
|
})}
|
||||||
|
value={output.url}
|
||||||
fluid
|
fluid
|
||||||
placeholder='http://127.0.0.1/start/1'
|
placeholder='http://127.0.0.1/start/1'
|
||||||
/>
|
/>
|
||||||
|
|||||||
+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>
|
||||||
|
|||||||
+51
-28
@@ -5,6 +5,7 @@ import { UseFormRegister, UseFormSetValue, UseFormWatch } from 'react-hook-form'
|
|||||||
import Input from '../../../../common/components/input/input/Input';
|
import Input from '../../../../common/components/input/input/Input';
|
||||||
import Select from '../../../../common/components/select/Select';
|
import Select from '../../../../common/components/select/Select';
|
||||||
import * as Panel from '../../panel-utils/PanelUtils';
|
import * as Panel from '../../panel-utils/PanelUtils';
|
||||||
|
import TemplateInput from './template-input/TemplateInput';
|
||||||
|
|
||||||
import style from './AutomationForm.module.scss';
|
import style from './AutomationForm.module.scss';
|
||||||
|
|
||||||
@@ -71,8 +72,8 @@ export default function OntimeActionForm({
|
|||||||
{ value: 'playback-pause', label: 'Playback: pause' },
|
{ value: 'playback-pause', label: 'Playback: pause' },
|
||||||
{ value: 'playback-roll', label: 'Playback: roll' },
|
{ value: 'playback-roll', label: 'Playback: roll' },
|
||||||
|
|
||||||
{ value: 'message-set', label: 'Primary Message: set' },
|
{ value: 'message-set', label: 'Primary Message' },
|
||||||
{ value: 'message-secondary', label: 'Secondary Message: source' },
|
{ value: 'message-secondary', label: 'Secondary Message' },
|
||||||
]}
|
]}
|
||||||
/>
|
/>
|
||||||
<Panel.Error>{rowErrors?.action?.message}</Panel.Error>
|
<Panel.Error>{rowErrors?.action?.message}</Panel.Error>
|
||||||
@@ -96,7 +97,12 @@ export default function OntimeActionForm({
|
|||||||
<>
|
<>
|
||||||
<label>
|
<label>
|
||||||
Text (leave empty for no change)
|
Text (leave empty for no change)
|
||||||
<Input {...register(`outputs.${index}.text`)} fluid placeholder='eg: Timer is finished' />
|
<TemplateInput
|
||||||
|
{...register(`outputs.${index}.text`)}
|
||||||
|
value={watch(`outputs.${index}.text`) ?? ''}
|
||||||
|
fluid
|
||||||
|
placeholder='eg: Timer is finished'
|
||||||
|
/>
|
||||||
<Panel.Error>{rowErrors?.text?.message}</Panel.Error>
|
<Panel.Error>{rowErrors?.text?.message}</Panel.Error>
|
||||||
</label>
|
</label>
|
||||||
<label>
|
<label>
|
||||||
@@ -120,31 +126,48 @@ export default function OntimeActionForm({
|
|||||||
)}
|
)}
|
||||||
|
|
||||||
{selectedAction === 'message-secondary' && (
|
{selectedAction === 'message-secondary' && (
|
||||||
<label>
|
<>
|
||||||
Timer secondary source
|
<label>
|
||||||
<Select<SecondarySource | 'null' | null>
|
Text (leave empty for no change)
|
||||||
onValueChange={(value) => {
|
<TemplateInput
|
||||||
// null -> no selection
|
{...register(`outputs.${index}.text`)}
|
||||||
if (value === null) return;
|
value={watch(`outputs.${index}.text`) ?? ''}
|
||||||
// 'null' -> clear the secondary source
|
fluid
|
||||||
if (value === 'null') {
|
placeholder='eg: Next up: keynote'
|
||||||
setValue(`outputs.${index}.secondarySource`, null, { shouldDirty: true });
|
/>
|
||||||
return;
|
<Panel.Error>{rowErrors?.text?.message}</Panel.Error>
|
||||||
}
|
</label>
|
||||||
setValue(`outputs.${index}.secondarySource`, value, { shouldDirty: true });
|
<label>
|
||||||
}}
|
Timer secondary source
|
||||||
value={watch(`outputs.${index}.secondarySource`)}
|
<Select<SecondarySource | 'no-change' | 'null' | null>
|
||||||
options={[
|
onValueChange={(value) => {
|
||||||
{ value: null, label: 'Select secondary source' },
|
// null -> no selection
|
||||||
{ value: 'aux1', label: 'Auxiliary timer 1' },
|
if (value === null) return;
|
||||||
{ value: 'aux2', label: 'Auxiliary timer 2' },
|
// no-change -> leave the current secondary source untouched
|
||||||
{ value: 'aux3', label: 'Auxiliary timer 3' },
|
if (value === 'no-change') {
|
||||||
{ value: 'secondary', label: 'Secondary' },
|
setValue(`outputs.${index}.secondarySource`, undefined, { shouldDirty: true });
|
||||||
{ value: 'null', label: 'None' }, // allow the user to clear the secondary source
|
return;
|
||||||
]}
|
}
|
||||||
/>
|
// 'null' -> clear the secondary source
|
||||||
<Panel.Error>{rowErrors?.secondarySource?.message}</Panel.Error>
|
if (value === 'null') {
|
||||||
</label>
|
setValue(`outputs.${index}.secondarySource`, null, { shouldDirty: true });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
setValue(`outputs.${index}.secondarySource`, value, { shouldDirty: true });
|
||||||
|
}}
|
||||||
|
value={watch(`outputs.${index}.secondarySource`) ?? 'no-change'}
|
||||||
|
options={[
|
||||||
|
{ value: 'no-change', label: 'No change' },
|
||||||
|
{ value: 'aux1', label: 'Auxiliary timer 1' },
|
||||||
|
{ value: 'aux2', label: 'Auxiliary timer 2' },
|
||||||
|
{ value: 'aux3', label: 'Auxiliary timer 3' },
|
||||||
|
{ value: 'secondary', label: 'Secondary' },
|
||||||
|
{ value: 'null', label: 'None' }, // allow the user to clear the secondary source
|
||||||
|
]}
|
||||||
|
/>
|
||||||
|
<Panel.Error>{rowErrors?.secondarySource?.message}</Panel.Error>
|
||||||
|
</label>
|
||||||
|
</>
|
||||||
)}
|
)}
|
||||||
|
|
||||||
<div className={style.test}>{children}</div>
|
<div className={style.test}>{children}</div>
|
||||||
|
|||||||
@@ -79,7 +79,7 @@ export default function TriggersList(props: TriggersListProps) {
|
|||||||
<tbody>
|
<tbody>
|
||||||
{!showForm && triggers.length === 0 && (
|
{!showForm && triggers.length === 0 && (
|
||||||
<Panel.TableEmpty
|
<Panel.TableEmpty
|
||||||
label='Create an automation to attach triggers to'
|
label='Create a trigger to run an automation'
|
||||||
handleClick={canAdd ? () => setShowForm(true) : undefined}
|
handleClick={canAdd ? () => setShowForm(true) : undefined}
|
||||||
/>
|
/>
|
||||||
)}
|
)}
|
||||||
|
|||||||
+55
-17
@@ -1,29 +1,67 @@
|
|||||||
.wrapper {
|
.inputShell {
|
||||||
position: relative;
|
position: relative;
|
||||||
}
|
}
|
||||||
|
|
||||||
.suggestions {
|
.fluid {
|
||||||
background: $gray-1250;
|
|
||||||
color: $ui-white;
|
|
||||||
|
|
||||||
position: absolute;
|
|
||||||
top: 100%;
|
|
||||||
left: 0;
|
|
||||||
width: 100%;
|
width: 100%;
|
||||||
margin: 0;
|
}
|
||||||
z-index: $zindex-floating;
|
|
||||||
padding-block: 0.25rem;
|
|
||||||
|
|
||||||
max-height: 200px;
|
.input {
|
||||||
overflow-y: auto;
|
padding-right: 2rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.expandButton {
|
||||||
|
position: absolute;
|
||||||
|
top: 50%;
|
||||||
|
right: 0.25rem;
|
||||||
|
transform: translateY(-50%);
|
||||||
|
}
|
||||||
|
|
||||||
|
.positioner {
|
||||||
|
outline: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.popup {
|
||||||
|
box-sizing: border-box;
|
||||||
|
min-width: var(--anchor-width);
|
||||||
|
max-width: var(--available-width);
|
||||||
|
border: 1px solid $gray-1000;
|
||||||
|
border-radius: $component-border-radius-md;
|
||||||
|
background: $gray-1250;
|
||||||
color: $label-gray;
|
color: $label-gray;
|
||||||
|
}
|
||||||
|
|
||||||
li {
|
.list {
|
||||||
padding: 0.25rem;
|
box-sizing: border-box;
|
||||||
}
|
max-height: min(20rem, var(--available-height));
|
||||||
|
overflow-y: auto;
|
||||||
|
overscroll-behavior: contain;
|
||||||
|
padding-block: 0.25rem;
|
||||||
|
outline: 0;
|
||||||
|
}
|
||||||
|
|
||||||
li:hover {
|
.item {
|
||||||
|
box-sizing: border-box;
|
||||||
|
padding: 0.25rem 0.5rem;
|
||||||
|
outline: 0;
|
||||||
|
cursor: default;
|
||||||
|
user-select: none;
|
||||||
|
overflow-wrap: anywhere;
|
||||||
|
|
||||||
|
&[data-highlighted] {
|
||||||
color: $ui-white;
|
color: $ui-white;
|
||||||
background: $blue-700;
|
background: $blue-700;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.expandedEditor {
|
||||||
|
min-height: min(18rem, 45vh);
|
||||||
|
font-family: monospace;
|
||||||
|
line-height: 1.4;
|
||||||
|
}
|
||||||
|
|
||||||
|
.footerHint {
|
||||||
|
margin-right: auto;
|
||||||
|
color: $label-gray;
|
||||||
|
font-size: calc(1rem - 2px);
|
||||||
|
}
|
||||||
|
|||||||
+236
-47
@@ -1,69 +1,258 @@
|
|||||||
import { mergeRefs, useClickOutside } from '@mantine/hooks';
|
import { Autocomplete as BaseAutocomplete } from '@base-ui/react/autocomplete';
|
||||||
import { forwardRef, useMemo, useState } from 'react';
|
import type { ChangeEvent, ReactNode, Ref } from 'react';
|
||||||
|
import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
|
||||||
|
import { IoExpandOutline } from 'react-icons/io5';
|
||||||
|
|
||||||
import Input, { type InputProps } from '../../../../../common/components/input/input/Input';
|
import Button from '../../../../../common/components/buttons/Button';
|
||||||
|
import IconButton from '../../../../../common/components/buttons/IconButton';
|
||||||
|
import { type InputProps } from '../../../../../common/components/input/input/Input';
|
||||||
|
import Textarea from '../../../../../common/components/input/textarea/Textarea';
|
||||||
|
import Modal from '../../../../../common/components/modal/Modal';
|
||||||
import useCustomFields from '../../../../../common/hooks-query/useCustomFields';
|
import useCustomFields from '../../../../../common/hooks-query/useCustomFields';
|
||||||
import { makeAutoCompleteList, matchRemaining, selectFromLastTemplate } from './templateInput.utils';
|
import { cx } from '../../../../../common/utils/styleUtils';
|
||||||
|
import { makeAutoCompleteList } from './templateInput.utils';
|
||||||
|
import { useTemplateAutocomplete } from './useTemplateAutocomplete';
|
||||||
|
|
||||||
|
import inputStyle from '../../../../../common/components/input/input/Input.module.scss';
|
||||||
import style from './TemplateInput.module.scss';
|
import style from './TemplateInput.module.scss';
|
||||||
|
|
||||||
interface TemplateInputProps extends InputProps {}
|
interface TemplateInputProps extends Omit<InputProps, 'value'> {
|
||||||
|
ref?: Ref<HTMLInputElement>;
|
||||||
|
value?: string;
|
||||||
|
}
|
||||||
|
|
||||||
const TemplateInput = forwardRef(function TemplateInput(props: TemplateInputProps, ref) {
|
interface TemplateEditorModalProps {
|
||||||
const { value, onChange, ...rest } = props;
|
autocompleteList: string[];
|
||||||
|
isOpen: boolean;
|
||||||
|
onClose: () => void;
|
||||||
|
onSave: (value: string) => void;
|
||||||
|
value: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
type TemplateAutocompleteState = ReturnType<typeof useTemplateAutocomplete<HTMLInputElement>>;
|
||||||
|
|
||||||
|
interface TemplateAutocompleteRootProps {
|
||||||
|
autocomplete: TemplateAutocompleteState;
|
||||||
|
children: ReactNode;
|
||||||
|
value: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
function assignRef<T>(ref: Ref<T> | undefined, value: T | null) {
|
||||||
|
if (typeof ref === 'function') {
|
||||||
|
ref(value);
|
||||||
|
} else if (ref) {
|
||||||
|
ref.current = value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function emitInputChange(name: string | undefined, value: string, onChange: InputProps['onChange']) {
|
||||||
|
onChange?.({
|
||||||
|
target: { name, value },
|
||||||
|
currentTarget: { name, value },
|
||||||
|
} as ChangeEvent<HTMLInputElement>);
|
||||||
|
}
|
||||||
|
|
||||||
|
export default function TemplateInput({
|
||||||
|
className,
|
||||||
|
disabled,
|
||||||
|
fluid,
|
||||||
|
height = 'medium',
|
||||||
|
onChange,
|
||||||
|
readOnly,
|
||||||
|
ref,
|
||||||
|
value,
|
||||||
|
variant = 'subtle',
|
||||||
|
...rest
|
||||||
|
}: TemplateInputProps) {
|
||||||
const { data } = useCustomFields();
|
const { data } = useCustomFields();
|
||||||
const localRef = useClickOutside(() => setShowSuggestions(false));
|
const inputRef = useRef<HTMLInputElement | null>(null);
|
||||||
|
const [inputValue, setInputValue] = useState(value || '');
|
||||||
|
const [isExpanded, setIsExpanded] = useState(false);
|
||||||
|
|
||||||
const autocompleteList = useMemo(() => {
|
const autocompleteList = useMemo(() => {
|
||||||
return makeAutoCompleteList(data);
|
return makeAutoCompleteList(data);
|
||||||
}, [data]);
|
}, [data]);
|
||||||
|
|
||||||
const [inputValue, setInputValue] = useState(value || '');
|
const updateInputValue = useCallback(
|
||||||
const [suggestions, setSuggestions] = useState<string[]>([]);
|
(nextValue: string) => {
|
||||||
const [showSuggestions, setShowSuggestions] = useState(false);
|
setInputValue(nextValue);
|
||||||
|
emitInputChange(rest.name, nextValue, onChange);
|
||||||
|
},
|
||||||
|
[onChange, rest.name],
|
||||||
|
);
|
||||||
|
|
||||||
const updateSuggestions = (value: string) => {
|
const autocomplete = useTemplateAutocomplete(inputValue, autocompleteList, inputRef, updateInputValue);
|
||||||
const template = selectFromLastTemplate(value);
|
const { setCursorForValue } = autocomplete;
|
||||||
return autocompleteList.filter((suggestion) => suggestion.startsWith(template));
|
|
||||||
|
// Keep the local autocomplete input in sync when react-hook-form resets or swaps field-array values.
|
||||||
|
useEffect(() => {
|
||||||
|
const nextValue = value || '';
|
||||||
|
setInputValue(nextValue);
|
||||||
|
setCursorForValue(nextValue, nextValue.length);
|
||||||
|
}, [setCursorForValue, value]);
|
||||||
|
|
||||||
|
const setInputRef = useCallback(
|
||||||
|
(element: HTMLInputElement | null) => {
|
||||||
|
inputRef.current = element;
|
||||||
|
assignRef(ref, element);
|
||||||
|
},
|
||||||
|
[ref],
|
||||||
|
);
|
||||||
|
|
||||||
|
const openExpandedEditor = () => {
|
||||||
|
autocomplete.setShowSuggestions(false);
|
||||||
|
setIsExpanded(true);
|
||||||
};
|
};
|
||||||
|
|
||||||
const handleInputChange = (event: React.ChangeEvent<HTMLInputElement>) => {
|
const closeExpandedEditor = () => {
|
||||||
setInputValue(event.target.value);
|
setIsExpanded(false);
|
||||||
|
|
||||||
if (event.target.value.endsWith('{')) {
|
|
||||||
setShowSuggestions(true);
|
|
||||||
setSuggestions(updateSuggestions(event.target.value));
|
|
||||||
} else if (event.target.value === '' || event.target.value.endsWith('}}')) {
|
|
||||||
setShowSuggestions(false);
|
|
||||||
} else if (showSuggestions) {
|
|
||||||
setSuggestions(updateSuggestions(event.target.value));
|
|
||||||
}
|
|
||||||
|
|
||||||
onChange?.(event);
|
|
||||||
};
|
};
|
||||||
|
|
||||||
const handleSuggestion = (value: string) => {
|
const saveExpandedEditor = (nextValue: string) => {
|
||||||
setInputValue((prev) => {
|
updateInputValue(nextValue);
|
||||||
const remaining = matchRemaining(prev as string, value);
|
autocomplete.setCursorForValue(nextValue, nextValue.length);
|
||||||
return prev + remaining;
|
setIsExpanded(false);
|
||||||
});
|
|
||||||
setShowSuggestions(false);
|
|
||||||
};
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className={style.wrapper} ref={mergeRefs(localRef, ref)}>
|
<>
|
||||||
<Input value={inputValue} {...rest} onChange={handleInputChange} fluid />
|
<TemplateAutocompleteRoot autocomplete={autocomplete} value={inputValue}>
|
||||||
{showSuggestions && suggestions.length > 0 && (
|
<div className={cx([style.inputShell, fluid && style.fluid])}>
|
||||||
<ul className={style.suggestions}>
|
<BaseAutocomplete.Input
|
||||||
{suggestions.map((suggestion) => (
|
ref={setInputRef}
|
||||||
<li key={suggestion} onClick={() => handleSuggestion(suggestion)}>
|
className={cx([
|
||||||
{suggestion}
|
inputStyle.input,
|
||||||
</li>
|
inputStyle[variant],
|
||||||
))}
|
inputStyle[height],
|
||||||
</ul>
|
fluid && inputStyle.fluid,
|
||||||
)}
|
style.input,
|
||||||
</div>
|
className,
|
||||||
|
])}
|
||||||
|
{...rest}
|
||||||
|
disabled={disabled}
|
||||||
|
onClick={autocomplete.updateCursor}
|
||||||
|
onFocus={autocomplete.updateCursor}
|
||||||
|
onKeyUp={autocomplete.updateCursor}
|
||||||
|
onSelect={autocomplete.updateCursor}
|
||||||
|
readOnly={readOnly}
|
||||||
|
/>
|
||||||
|
<IconButton
|
||||||
|
aria-label='Expand template editor'
|
||||||
|
className={style.expandButton}
|
||||||
|
disabled={disabled || readOnly}
|
||||||
|
onClick={openExpandedEditor}
|
||||||
|
size='small'
|
||||||
|
title='Expand template editor'
|
||||||
|
variant='ghosted-white'
|
||||||
|
>
|
||||||
|
<IoExpandOutline />
|
||||||
|
</IconButton>
|
||||||
|
</div>
|
||||||
|
</TemplateAutocompleteRoot>
|
||||||
|
<TemplateEditorModal
|
||||||
|
autocompleteList={autocompleteList}
|
||||||
|
isOpen={isExpanded}
|
||||||
|
onClose={closeExpandedEditor}
|
||||||
|
onSave={saveExpandedEditor}
|
||||||
|
value={inputValue}
|
||||||
|
/>
|
||||||
|
</>
|
||||||
);
|
);
|
||||||
});
|
}
|
||||||
|
|
||||||
export default TemplateInput;
|
function TemplateAutocompleteRoot({ autocomplete, children, value }: TemplateAutocompleteRootProps) {
|
||||||
|
return (
|
||||||
|
<BaseAutocomplete.Root
|
||||||
|
items={autocomplete.suggestions}
|
||||||
|
autoHighlight
|
||||||
|
highlightItemOnHover
|
||||||
|
mode='none'
|
||||||
|
open={autocomplete.open}
|
||||||
|
value={value}
|
||||||
|
onOpenChange={autocomplete.setShowSuggestions}
|
||||||
|
onValueChange={autocomplete.handleValueChange}
|
||||||
|
>
|
||||||
|
{children}
|
||||||
|
<TemplateSuggestionPopup />
|
||||||
|
</BaseAutocomplete.Root>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function TemplateEditorModal({ autocompleteList, isOpen, onClose, onSave, value }: TemplateEditorModalProps) {
|
||||||
|
const expandedInputRef = useRef<HTMLTextAreaElement | null>(null);
|
||||||
|
const [draftValue, setDraftValue] = useState(value);
|
||||||
|
const autocomplete = useTemplateAutocomplete(draftValue, autocompleteList, expandedInputRef, setDraftValue);
|
||||||
|
const { setShowSuggestions } = autocomplete;
|
||||||
|
|
||||||
|
// Reset the draft whenever the modal opens so cancel never leaks unsaved changes.
|
||||||
|
useEffect(() => {
|
||||||
|
if (!isOpen) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
setDraftValue(value);
|
||||||
|
setShowSuggestions(false);
|
||||||
|
}, [isOpen, setShowSuggestions, value]);
|
||||||
|
|
||||||
|
const handleClose = () => {
|
||||||
|
setShowSuggestions(false);
|
||||||
|
onClose();
|
||||||
|
};
|
||||||
|
|
||||||
|
const handleSave = () => {
|
||||||
|
setShowSuggestions(false);
|
||||||
|
onSave(draftValue);
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Modal
|
||||||
|
isOpen={isOpen}
|
||||||
|
onClose={handleClose}
|
||||||
|
showBackdrop
|
||||||
|
showCloseButton
|
||||||
|
title='Edit template'
|
||||||
|
bodyElements={
|
||||||
|
<TemplateAutocompleteRoot autocomplete={autocomplete} value={draftValue}>
|
||||||
|
<BaseAutocomplete.Input
|
||||||
|
autoFocus
|
||||||
|
className={style.expandedEditor}
|
||||||
|
onClick={autocomplete.updateCursor}
|
||||||
|
onFocus={autocomplete.updateCursor}
|
||||||
|
onKeyUp={autocomplete.updateCursor}
|
||||||
|
onSelect={autocomplete.updateCursor}
|
||||||
|
render={<Textarea ref={expandedInputRef} fluid resize='none' rows={8} />}
|
||||||
|
/>
|
||||||
|
</TemplateAutocompleteRoot>
|
||||||
|
}
|
||||||
|
footerElements={
|
||||||
|
<>
|
||||||
|
<span className={style.footerHint}>Start a template with {'{{'} to see autocomplete.</span>
|
||||||
|
<Button onClick={handleClose}>Cancel</Button>
|
||||||
|
<Button onClick={handleSave} variant='primary'>
|
||||||
|
Save
|
||||||
|
</Button>
|
||||||
|
</>
|
||||||
|
}
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function TemplateSuggestionPopup() {
|
||||||
|
return (
|
||||||
|
<BaseAutocomplete.Portal>
|
||||||
|
<BaseAutocomplete.Positioner side='bottom' align='start' className={style.positioner}>
|
||||||
|
<BaseAutocomplete.Popup className={style.popup}>
|
||||||
|
<BaseAutocomplete.List className={style.list}>
|
||||||
|
<BaseAutocomplete.Collection>
|
||||||
|
{(suggestion: string) => (
|
||||||
|
<BaseAutocomplete.Item key={suggestion} value={suggestion} className={style.item}>
|
||||||
|
{suggestion}
|
||||||
|
</BaseAutocomplete.Item>
|
||||||
|
)}
|
||||||
|
</BaseAutocomplete.Collection>
|
||||||
|
</BaseAutocomplete.List>
|
||||||
|
</BaseAutocomplete.Popup>
|
||||||
|
</BaseAutocomplete.Positioner>
|
||||||
|
</BaseAutocomplete.Portal>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|||||||
+52
-1
@@ -1,4 +1,4 @@
|
|||||||
import { matchRemaining } from '../templateInput.utils';
|
import { completeTemplateAtCursor, matchRemaining, selectActiveTemplate } from '../templateInput.utils';
|
||||||
|
|
||||||
describe('matchRemaining()', () => {
|
describe('matchRemaining()', () => {
|
||||||
it('should return a partial string needed for autocomplete', () => {
|
it('should return a partial string needed for autocomplete', () => {
|
||||||
@@ -15,3 +15,54 @@ describe('matchRemaining()', () => {
|
|||||||
expect(matchRemaining('test', 'test')).toBe('');
|
expect(matchRemaining('test', 'test')).toBe('');
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe('selectActiveTemplate()', () => {
|
||||||
|
it('returns the last unclosed template fragment', () => {
|
||||||
|
expect(selectActiveTemplate('send {{event')).toBe('{{event');
|
||||||
|
expect(selectActiveTemplate('send {{eventNow.title}} and {{event')).toBe('{{event');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('ignores single braces and closed templates', () => {
|
||||||
|
expect(selectActiveTemplate('send {')).toBe('');
|
||||||
|
expect(selectActiveTemplate('send {{eventNow.title}}')).toBe('');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('only considers templates before the cursor', () => {
|
||||||
|
expect(selectActiveTemplate('send {{event}} then {{timer', 14)).toBe('');
|
||||||
|
expect(selectActiveTemplate('send {{event}} then {{timer', 27)).toBe('{{timer');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('selects a partial template when the cursor is inside a completed template', () => {
|
||||||
|
expect(selectActiveTemplate('send {{timer.current}} after', 12)).toBe('{{timer');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('completeTemplateAtCursor()', () => {
|
||||||
|
it('completes the active template before the cursor', () => {
|
||||||
|
expect(completeTemplateAtCursor('send {{timer after', '{{timer.current}}', 12)).toEqual({
|
||||||
|
value: 'send {{timer.current}} after',
|
||||||
|
cursorIndex: 22,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('preserves text before and after the cursor', () => {
|
||||||
|
expect(completeTemplateAtCursor('before {{event after', '{{eventNow.title}}', 14)).toEqual({
|
||||||
|
value: 'before {{eventNow.title}} after',
|
||||||
|
cursorIndex: 25,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('preserves a following template when completing between templates', () => {
|
||||||
|
expect(completeTemplateAtCursor('{{clock}} and {{timer then {{eventNow.title}}', '{{timer.current}}', 21)).toEqual({
|
||||||
|
value: '{{clock}} and {{timer.current}} then {{eventNow.title}}',
|
||||||
|
cursorIndex: 31,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('replaces the whole template when the cursor is inside a completed template', () => {
|
||||||
|
expect(completeTemplateAtCursor('before {{timer.current}} after', '{{timer.duration}}', 15)).toEqual({
|
||||||
|
value: 'before {{timer.duration}} after',
|
||||||
|
cursorIndex: 25,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|||||||
+66
-8
@@ -54,6 +54,16 @@ const eventStaticPropertiesNext = [
|
|||||||
'{{eventNext.delay}}',
|
'{{eventNext.delay}}',
|
||||||
];
|
];
|
||||||
|
|
||||||
|
const groupStaticPropertiesNow = [
|
||||||
|
'{{groupNow.id}}',
|
||||||
|
'{{groupNow.title}}',
|
||||||
|
'{{groupNow.note}}',
|
||||||
|
'{{groupNow.colour}}',
|
||||||
|
'{{groupNow.timeStart}}',
|
||||||
|
'{{groupNow.timeEnd}}',
|
||||||
|
'{{groupNow.duration}}',
|
||||||
|
];
|
||||||
|
|
||||||
const staticAuxProperties = (index: 1 | 2 | 3) => [
|
const staticAuxProperties = (index: 1 | 2 | 3) => [
|
||||||
`{{auxtimer${index}.current}}`,
|
`{{auxtimer${index}.current}}`,
|
||||||
`{{auxtimer${index}.duration}}`,
|
`{{auxtimer${index}.duration}}`,
|
||||||
@@ -75,12 +85,19 @@ export function makeAutoCompleteList(customFields: CustomFields): string[] {
|
|||||||
...Object.entries(customFields).map(([key]) => `{{eventNow.custom.${key}}}`),
|
...Object.entries(customFields).map(([key]) => `{{eventNow.custom.${key}}}`),
|
||||||
...eventStaticPropertiesNext,
|
...eventStaticPropertiesNext,
|
||||||
...Object.entries(customFields).map(([key]) => `{{eventNext.custom.${key}}}`),
|
...Object.entries(customFields).map(([key]) => `{{eventNext.custom.${key}}}`),
|
||||||
|
...groupStaticPropertiesNow,
|
||||||
|
...Object.entries(customFields).map(([key]) => `{{groupNow.custom.${key}}}`),
|
||||||
...staticAuxProperties(1),
|
...staticAuxProperties(1),
|
||||||
...staticAuxProperties(2),
|
...staticAuxProperties(2),
|
||||||
...staticAuxProperties(3),
|
...staticAuxProperties(3),
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
interface TemplateCompletion {
|
||||||
|
cursorIndex: number;
|
||||||
|
value: string;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the partial string b needed to autocomplete string a
|
* Returns the partial string b needed to autocomplete string a
|
||||||
* @example matchRemaining('te', 'test') -> 'st'
|
* @example matchRemaining('te', 'test') -> 'st'
|
||||||
@@ -111,13 +128,54 @@ export function matchRemaining(a: string, b: string) {
|
|||||||
return '';
|
return '';
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
function getActiveTemplateRange(text: string, cursorIndex = text.length) {
|
||||||
* Selects the last starting template in a string
|
const textBeforeCursor = text.slice(0, cursorIndex);
|
||||||
*/
|
const start = textBeforeCursor.lastIndexOf('{{');
|
||||||
export function selectFromLastTemplate(text: string) {
|
if (start === -1) {
|
||||||
const lastBraceIndex = text.lastIndexOf('{{');
|
return null;
|
||||||
if (lastBraceIndex !== -1) {
|
|
||||||
return text.slice(lastBraceIndex);
|
|
||||||
}
|
}
|
||||||
return '';
|
|
||||||
|
const closeBeforeCursor = textBeforeCursor.lastIndexOf('}}');
|
||||||
|
if (closeBeforeCursor > start) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const closeAfterStart = text.indexOf('}}', start);
|
||||||
|
const nextStartAfterCursor = text.indexOf('{{', cursorIndex);
|
||||||
|
const closesBeforeNextTemplate = nextStartAfterCursor === -1 || closeAfterStart < nextStartAfterCursor;
|
||||||
|
const end = closeAfterStart !== -1 && closesBeforeNextTemplate ? closeAfterStart + 2 : cursorIndex;
|
||||||
|
|
||||||
|
return {
|
||||||
|
end,
|
||||||
|
start,
|
||||||
|
template: text.slice(start, cursorIndex),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Selects the last unclosed starting template before the cursor.
|
||||||
|
*/
|
||||||
|
export function selectActiveTemplate(text: string, cursorIndex = text.length) {
|
||||||
|
return getActiveTemplateRange(text, cursorIndex)?.template ?? '';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Replaces the active template fragment before the cursor with the selected suggestion.
|
||||||
|
*/
|
||||||
|
export function completeTemplateAtCursor(
|
||||||
|
text: string,
|
||||||
|
suggestion: string,
|
||||||
|
cursorIndex = text.length,
|
||||||
|
): TemplateCompletion {
|
||||||
|
const activeTemplateRange = getActiveTemplateRange(text, cursorIndex);
|
||||||
|
if (!activeTemplateRange) {
|
||||||
|
const value = text + matchRemaining(text, suggestion);
|
||||||
|
return { value, cursorIndex: value.length };
|
||||||
|
}
|
||||||
|
|
||||||
|
const value = `${text.slice(0, activeTemplateRange.start)}${suggestion}${text.slice(activeTemplateRange.end)}`;
|
||||||
|
return {
|
||||||
|
value,
|
||||||
|
cursorIndex: activeTemplateRange.start + suggestion.length,
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
+72
@@ -0,0 +1,72 @@
|
|||||||
|
import { Autocomplete as BaseAutocomplete } from '@base-ui/react/autocomplete';
|
||||||
|
import { useCallback, useMemo, useState, type RefObject } from 'react';
|
||||||
|
|
||||||
|
import { completeTemplateAtCursor, selectActiveTemplate } from './templateInput.utils';
|
||||||
|
|
||||||
|
type TemplateElement = HTMLInputElement | HTMLTextAreaElement;
|
||||||
|
|
||||||
|
function getCursorIndex(element: TemplateElement | null, fallback: string) {
|
||||||
|
return element?.selectionStart ?? fallback.length;
|
||||||
|
}
|
||||||
|
|
||||||
|
function focusCursor(element: TemplateElement | null, cursorIndex: number) {
|
||||||
|
requestAnimationFrame(() => {
|
||||||
|
element?.focus();
|
||||||
|
element?.setSelectionRange(cursorIndex, cursorIndex);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useTemplateAutocomplete<T extends TemplateElement>(
|
||||||
|
value: string,
|
||||||
|
autocompleteList: string[],
|
||||||
|
elementRef: RefObject<T | null>,
|
||||||
|
onValueChange: (value: string) => void,
|
||||||
|
) {
|
||||||
|
const [showSuggestions, setShowSuggestions] = useState(false);
|
||||||
|
const [cursor, setCursor] = useState(value.length);
|
||||||
|
|
||||||
|
const activeTemplate = selectActiveTemplate(value, cursor);
|
||||||
|
const suggestions = useMemo(() => {
|
||||||
|
if (!activeTemplate) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
return autocompleteList.filter((suggestion) => suggestion.startsWith(activeTemplate));
|
||||||
|
}, [activeTemplate, autocompleteList]);
|
||||||
|
|
||||||
|
const setCursorForValue = useCallback((nextValue: string, cursorIndex: number) => {
|
||||||
|
setCursor(cursorIndex);
|
||||||
|
setShowSuggestions(Boolean(selectActiveTemplate(nextValue, cursorIndex)));
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
const updateCursor = useCallback(() => {
|
||||||
|
const cursorIndex = getCursorIndex(elementRef.current, value);
|
||||||
|
setCursorForValue(value, cursorIndex);
|
||||||
|
}, [elementRef, setCursorForValue, value]);
|
||||||
|
|
||||||
|
const handleValueChange = useCallback(
|
||||||
|
(nextValue: string, eventDetails: BaseAutocomplete.Root.ChangeEventDetails) => {
|
||||||
|
if (eventDetails.reason === 'item-press') {
|
||||||
|
eventDetails.cancel();
|
||||||
|
const completed = completeTemplateAtCursor(value, nextValue, cursor);
|
||||||
|
setCursorForValue(completed.value, completed.cursorIndex);
|
||||||
|
onValueChange(completed.value);
|
||||||
|
focusCursor(elementRef.current, completed.cursorIndex);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const cursorIndex = getCursorIndex(elementRef.current, nextValue);
|
||||||
|
setCursorForValue(nextValue, cursorIndex);
|
||||||
|
onValueChange(nextValue);
|
||||||
|
},
|
||||||
|
[cursor, elementRef, onValueChange, setCursorForValue, value],
|
||||||
|
);
|
||||||
|
|
||||||
|
return {
|
||||||
|
handleValueChange,
|
||||||
|
open: showSuggestions && suggestions.length > 0,
|
||||||
|
setCursorForValue,
|
||||||
|
setShowSuggestions,
|
||||||
|
suggestions,
|
||||||
|
updateCursor,
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -1,7 +1,8 @@
|
|||||||
import { URLPreset } from 'ontime-types';
|
import { OntimeView, URLPreset } from 'ontime-types';
|
||||||
import { useState } from 'react';
|
import { useState } from 'react';
|
||||||
import { IoAdd, IoOpenOutline, IoPencil, IoTrash } from 'react-icons/io5';
|
import { IoAdd, IoOpenOutline, IoPencil, IoTrash } from 'react-icons/io5';
|
||||||
|
|
||||||
|
import { maybeAxiosError } from '../../../../common/api/utils';
|
||||||
import Button from '../../../../common/components/buttons/Button';
|
import Button from '../../../../common/components/buttons/Button';
|
||||||
import IconButton from '../../../../common/components/buttons/IconButton';
|
import IconButton from '../../../../common/components/buttons/IconButton';
|
||||||
import Info from '../../../../common/components/info/Info';
|
import Info from '../../../../common/components/info/Info';
|
||||||
@@ -22,13 +23,23 @@ const urlPresetsDocs = 'https://docs.getontime.no/features/url-presets/';
|
|||||||
|
|
||||||
export default function URLPresets() {
|
export default function URLPresets() {
|
||||||
const [formState, setFormState] = useState<FormState>({ isOpen: false, preset: undefined });
|
const [formState, setFormState] = useState<FormState>({ isOpen: false, preset: undefined });
|
||||||
|
const [actionError, setActionError] = useState<string | null>(null);
|
||||||
const { data, status } = useUrlPresets();
|
const { data, status } = useUrlPresets();
|
||||||
const { deletePreset, isMutating } = useUpdateUrlPreset();
|
const { updatePreset, deletePreset, isMutating } = useUpdateUrlPreset();
|
||||||
|
|
||||||
const openNewForm = () => setFormState({ isOpen: true });
|
const openNewForm = () => setFormState({ isOpen: true });
|
||||||
const openEditForm = (preset: URLPreset) => setFormState({ isOpen: true, preset });
|
const openEditForm = (preset: URLPreset) => setFormState({ isOpen: true, preset });
|
||||||
const closeForm = () => setFormState({ isOpen: false, preset: undefined });
|
const closeForm = () => setFormState({ isOpen: false, preset: undefined });
|
||||||
|
|
||||||
|
const persistPreset = async (preset: URLPreset) => {
|
||||||
|
setActionError(null);
|
||||||
|
try {
|
||||||
|
await updatePreset(preset.alias, preset);
|
||||||
|
} catch (error) {
|
||||||
|
setActionError(maybeAxiosError(error));
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Panel.Section>
|
<Panel.Section>
|
||||||
<Panel.Card>
|
<Panel.Card>
|
||||||
@@ -53,10 +64,12 @@ export default function URLPresets() {
|
|||||||
<Panel.Section>
|
<Panel.Section>
|
||||||
<Panel.Loader isLoading={status === 'pending'} />
|
<Panel.Loader isLoading={status === 'pending'} />
|
||||||
{formState.isOpen && <URLPresetForm urlPreset={formState.preset} onClose={closeForm} />}
|
{formState.isOpen && <URLPresetForm urlPreset={formState.preset} onClose={closeForm} />}
|
||||||
|
{actionError && <Panel.Error>{actionError}</Panel.Error>}
|
||||||
<Panel.Table>
|
<Panel.Table>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Enabled</th>
|
<th>Enabled</th>
|
||||||
|
<th>Show in nav</th>
|
||||||
<th>Target view</th>
|
<th>Target view</th>
|
||||||
<th>Alias</th>
|
<th>Alias</th>
|
||||||
<th />
|
<th />
|
||||||
@@ -65,10 +78,23 @@ export default function URLPresets() {
|
|||||||
<tbody>
|
<tbody>
|
||||||
{data.length === 0 && <Panel.TableEmpty handleClick={openNewForm} />}
|
{data.length === 0 && <Panel.TableEmpty handleClick={openNewForm} />}
|
||||||
{data.map((preset, index) => {
|
{data.map((preset, index) => {
|
||||||
|
const isCuesheet = preset.target === OntimeView.Cuesheet;
|
||||||
return (
|
return (
|
||||||
<tr key={preset.alias}>
|
<tr key={preset.alias}>
|
||||||
<td>
|
<td>
|
||||||
<Switch defaultChecked={preset.enabled} onCheckedChange={() => {}} />
|
<Switch
|
||||||
|
checked={preset.enabled}
|
||||||
|
onCheckedChange={(enabled) => persistPreset({ ...preset, enabled })}
|
||||||
|
disabled={isMutating}
|
||||||
|
aria-label='Toggle preset enabled'
|
||||||
|
/>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<Switch
|
||||||
|
checked={preset.displayInNav}
|
||||||
|
onCheckedChange={(checked) => persistPreset({ ...preset, displayInNav: checked })}
|
||||||
|
disabled={isMutating || isCuesheet}
|
||||||
|
/>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<Tag>{preset.target}</Tag>
|
<Tag>{preset.target}</Tag>
|
||||||
|
|||||||
+88
-33
@@ -1,5 +1,5 @@
|
|||||||
import { OntimeView, OntimeViewPresettable, URLPreset } from 'ontime-types';
|
import { OntimeView, OntimeViewPresettable, URLPreset } from 'ontime-types';
|
||||||
import { useEffect, useRef } from 'react';
|
import { useEffect, useRef, useState } from 'react';
|
||||||
import { useForm } from 'react-hook-form';
|
import { useForm } from 'react-hook-form';
|
||||||
|
|
||||||
import { maybeAxiosError, unwrapError } from '../../../../../common/api/utils';
|
import { maybeAxiosError, unwrapError } from '../../../../../common/api/utils';
|
||||||
@@ -12,6 +12,7 @@ import { preventEscape } from '../../../../../common/utils/keyEvent';
|
|||||||
import { isUrlSafe } from '../../../../../common/utils/regex';
|
import { isUrlSafe } from '../../../../../common/utils/regex';
|
||||||
import { enDash } from '../../../../../common/utils/styleUtils';
|
import { enDash } from '../../../../../common/utils/styleUtils';
|
||||||
import { generateUrlPresetOptions } from '../../../../../common/utils/urlPresets';
|
import { generateUrlPresetOptions } from '../../../../../common/utils/urlPresets';
|
||||||
|
import CuesheetLinkOptions, { CuesheetPermissionValues } from '../../../../sharing/composite/CuesheetLinkOptions';
|
||||||
import * as Panel from '../../../panel-utils/PanelUtils';
|
import * as Panel from '../../../panel-utils/PanelUtils';
|
||||||
|
|
||||||
import style from './URLPresetForm.module.scss';
|
import style from './URLPresetForm.module.scss';
|
||||||
@@ -32,6 +33,7 @@ const defaultValues: URLPreset = {
|
|||||||
target: OntimeView.Timer,
|
target: OntimeView.Timer,
|
||||||
search: '',
|
search: '',
|
||||||
enabled: true,
|
enabled: true,
|
||||||
|
displayInNav: false,
|
||||||
};
|
};
|
||||||
|
|
||||||
interface URLPresetFormProps {
|
interface URLPresetFormProps {
|
||||||
@@ -61,12 +63,42 @@ export default function URLPresetForm({ urlPreset, onClose }: URLPresetFormProps
|
|||||||
});
|
});
|
||||||
const urlRef = useRef<HTMLInputElement>(null);
|
const urlRef = useRef<HTMLInputElement>(null);
|
||||||
|
|
||||||
|
// Cuesheet read/write permissions live outside react-hook-form
|
||||||
|
const initialPermissions = useRef<CuesheetPermissionValues>({
|
||||||
|
read: urlPreset?.options?.read ?? 'full',
|
||||||
|
write: urlPreset?.options?.write ?? 'full',
|
||||||
|
});
|
||||||
|
const [cuesheetPermissions, setCuesheetPermissions] = useState<CuesheetPermissionValues>(initialPermissions.current);
|
||||||
|
|
||||||
|
// update initial permissions on mount
|
||||||
|
useEffect(() => {
|
||||||
|
initialPermissions.current = {
|
||||||
|
read: urlPreset?.options?.read ?? 'full',
|
||||||
|
write: urlPreset?.options?.write ?? 'full',
|
||||||
|
};
|
||||||
|
setCuesheetPermissions(initialPermissions.current);
|
||||||
|
// oxlint-disable-next-line eslint-plugin-react-hooks/exhaustive-deps -- run on mount
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
const isEditingCuesheet = urlPreset && urlPreset.target === OntimeView.Cuesheet;
|
||||||
|
const isCuesheet = watch('target') === OntimeView.Cuesheet;
|
||||||
|
const permissionsDirty =
|
||||||
|
isCuesheet &&
|
||||||
|
(cuesheetPermissions.read !== initialPermissions.current.read ||
|
||||||
|
cuesheetPermissions.write !== initialPermissions.current.write);
|
||||||
|
const noReadAccess = isCuesheet && cuesheetPermissions.read === '-';
|
||||||
|
|
||||||
const setupSubmit = async (data: URLPreset) => {
|
const setupSubmit = async (data: URLPreset) => {
|
||||||
try {
|
try {
|
||||||
|
// Preserve / apply cuesheet permissions, which are not part of the form fields
|
||||||
|
const payload: URLPreset =
|
||||||
|
data.target === OntimeView.Cuesheet
|
||||||
|
? { ...data, target: OntimeView.Cuesheet, options: cuesheetPermissions }
|
||||||
|
: data;
|
||||||
if (urlPreset) {
|
if (urlPreset) {
|
||||||
await updatePreset(urlPreset.alias, data);
|
await updatePreset(urlPreset.alias, payload);
|
||||||
} else {
|
} else {
|
||||||
await addPreset(data);
|
await addPreset(payload);
|
||||||
}
|
}
|
||||||
onClose();
|
onClose();
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
@@ -74,6 +106,7 @@ export default function URLPresetForm({ urlPreset, onClose }: URLPresetFormProps
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// focus on alias when the form opens
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
setFocus('alias');
|
setFocus('alias');
|
||||||
}, [setFocus]);
|
}, [setFocus]);
|
||||||
@@ -126,44 +159,66 @@ export default function URLPresetForm({ urlPreset, onClose }: URLPresetFormProps
|
|||||||
<div className={style.expand}>
|
<div className={style.expand}>
|
||||||
<Panel.Description>Generate options (paste URL to generate options)</Panel.Description>
|
<Panel.Description>Generate options (paste URL to generate options)</Panel.Description>
|
||||||
<Panel.InlineElements>
|
<Panel.InlineElements>
|
||||||
<Input placeholder='Paste URL' fluid ref={urlRef} />
|
<Input placeholder='Paste URL' fluid ref={urlRef} disabled={isEditingCuesheet} />
|
||||||
<Button onClick={generateOptions}>Generate</Button>
|
<Button onClick={generateOptions} disabled={isEditingCuesheet}>
|
||||||
|
Generate
|
||||||
|
</Button>
|
||||||
</Panel.InlineElements>
|
</Panel.InlineElements>
|
||||||
</div>
|
</div>
|
||||||
</Panel.InlineElements>
|
</Panel.InlineElements>
|
||||||
{errors.alias?.message && <Panel.Error>{errors.alias.message}</Panel.Error>}
|
{errors.alias?.message && <Panel.Error>{errors.alias.message}</Panel.Error>}
|
||||||
<div>
|
{!isEditingCuesheet && (
|
||||||
{enDash} or {enDash}
|
<>
|
||||||
</div>
|
<div>
|
||||||
<div>2. Choose a view and its parameters</div>
|
{enDash} or {enDash}
|
||||||
<div>
|
</div>
|
||||||
<Panel.Description>Target</Panel.Description>
|
<div>2. Choose a view and its parameters</div>
|
||||||
<Select
|
<div>
|
||||||
options={targetOptions}
|
<Panel.Description>Target</Panel.Description>
|
||||||
{...register('target', { required: 'Target is required' })}
|
<Select
|
||||||
value={watch('target')}
|
options={targetOptions}
|
||||||
onValueChange={(value: OntimeViewPresettable | null) => {
|
{...register('target', { required: 'Target is required' })}
|
||||||
if (value === null) return;
|
value={watch('target')}
|
||||||
setValue('target', value, { shouldDirty: true });
|
onValueChange={(value: OntimeViewPresettable | null) => {
|
||||||
}}
|
if (value === null) return;
|
||||||
/>
|
setValue('target', value, { shouldDirty: true });
|
||||||
</div>
|
}}
|
||||||
<div>
|
/>
|
||||||
<Panel.Description>Parameters</Panel.Description>
|
</div>
|
||||||
<Textarea
|
<div>
|
||||||
fluid
|
<Panel.Description>Parameters</Panel.Description>
|
||||||
rows={3}
|
<Textarea
|
||||||
{...register('search', {
|
fluid
|
||||||
validate: validateParams,
|
rows={3}
|
||||||
})}
|
{...register('search', {
|
||||||
/>
|
validate: validateParams,
|
||||||
<Panel.Error>{errors.search?.message}</Panel.Error>
|
})}
|
||||||
</div>
|
/>
|
||||||
|
<Panel.Error>{errors.search?.message}</Panel.Error>
|
||||||
|
</div>
|
||||||
|
</>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{isCuesheet && (
|
||||||
|
<div>
|
||||||
|
<Panel.Description>Permissions</Panel.Description>
|
||||||
|
<CuesheetLinkOptions
|
||||||
|
initialRead={initialPermissions.current.read}
|
||||||
|
initialWrite={initialPermissions.current.write}
|
||||||
|
onChange={setCuesheetPermissions}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
<div>
|
<div>
|
||||||
<Panel.Error>{errors.root?.message}</Panel.Error>
|
<Panel.Error>{errors.root?.message}</Panel.Error>
|
||||||
<Panel.InlineElements align='end'>
|
<Panel.InlineElements align='end'>
|
||||||
<Button onClick={onClose}>Cancel</Button>
|
<Button onClick={onClose}>Cancel</Button>
|
||||||
<Button variant='primary' type='submit' disabled={!isValid || !isDirty} loading={isSubmitting || isMutating}>
|
<Button
|
||||||
|
variant='primary'
|
||||||
|
type='submit'
|
||||||
|
disabled={!isValid || (!isDirty && !permissionsDirty) || noReadAccess}
|
||||||
|
loading={isSubmitting || isMutating}
|
||||||
|
>
|
||||||
Save
|
Save
|
||||||
</Button>
|
</Button>
|
||||||
</Panel.InlineElements>
|
</Panel.InlineElements>
|
||||||
|
|||||||
@@ -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',
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ export default function RundownDefaultSettings() {
|
|||||||
defaultDangerTime,
|
defaultDangerTime,
|
||||||
defaultTimerType,
|
defaultTimerType,
|
||||||
defaultEndAction,
|
defaultEndAction,
|
||||||
|
inheritGroupColour,
|
||||||
setDefaultDuration,
|
setDefaultDuration,
|
||||||
setLinkPrevious,
|
setLinkPrevious,
|
||||||
setTimeStrategy,
|
setTimeStrategy,
|
||||||
@@ -23,6 +24,7 @@ export default function RundownDefaultSettings() {
|
|||||||
setDangerTime,
|
setDangerTime,
|
||||||
setDefaultTimerType,
|
setDefaultTimerType,
|
||||||
setDefaultEndAction,
|
setDefaultEndAction,
|
||||||
|
setInheritGroupColour,
|
||||||
} = useEditorSettings((state) => state);
|
} = useEditorSettings((state) => state);
|
||||||
|
|
||||||
const durationInMs = parseUserTime(defaultDuration);
|
const durationInMs = parseUserTime(defaultDuration);
|
||||||
@@ -44,6 +46,13 @@ export default function RundownDefaultSettings() {
|
|||||||
/>
|
/>
|
||||||
<Switch size='large' checked={linkPrevious} onCheckedChange={setLinkPrevious} />
|
<Switch size='large' checked={linkPrevious} onCheckedChange={setLinkPrevious} />
|
||||||
</Panel.ListItem>
|
</Panel.ListItem>
|
||||||
|
<Panel.ListItem>
|
||||||
|
<Panel.Field
|
||||||
|
title='Inherit group colour'
|
||||||
|
description='Whether new events and milestones inherit the colour of their parent group'
|
||||||
|
/>
|
||||||
|
<Switch size='large' checked={inheritGroupColour} onCheckedChange={setInheritGroupColour} />
|
||||||
|
</Panel.ListItem>
|
||||||
<Panel.ListItem>
|
<Panel.ListItem>
|
||||||
<Panel.Field
|
<Panel.Field
|
||||||
title='Timer strategy'
|
title='Timer strategy'
|
||||||
|
|||||||
+26
-19
@@ -15,23 +15,25 @@ import Input from '../../../../../common/components/input/input/Input';
|
|||||||
import Tag from '../../../../../common/components/tag/Tag';
|
import Tag from '../../../../../common/components/tag/Tag';
|
||||||
import { openLink } from '../../../../../common/utils/linkUtils';
|
import { openLink } from '../../../../../common/utils/linkUtils';
|
||||||
import * as Panel from '../../../panel-utils/PanelUtils';
|
import * as Panel from '../../../panel-utils/PanelUtils';
|
||||||
|
import { extractSheetId, getPersistedSheetId, persistSheetId } from './gsheetUtils';
|
||||||
|
|
||||||
import style from './SourcesPanel.module.scss';
|
import style from './SourcesPanel.module.scss';
|
||||||
|
|
||||||
interface GSheetSetupProps {
|
interface GSheetSetupProps {
|
||||||
onCancel: () => void;
|
onCancel: () => void;
|
||||||
onSheetLoaded: (sheetId: string, options: SpreadsheetWorksheetOptions) => void;
|
onSheetLoaded: (sheetId: string, options: SpreadsheetWorksheetOptions) => void;
|
||||||
|
closedByUser: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export default function GSheetSetup(props: GSheetSetupProps) {
|
export default function GSheetSetup(props: GSheetSetupProps) {
|
||||||
const { onCancel, onSheetLoaded } = props;
|
const { onCancel, onSheetLoaded, closedByUser } = props;
|
||||||
|
|
||||||
const [file, setFile] = useState<File | null>(null);
|
const [file, setFile] = useState<File | null>(null);
|
||||||
const [sheetId, setSheetId] = useState('');
|
const [sheetId, setSheetId] = useState(getPersistedSheetId);
|
||||||
const [authenticationStatus, setAuthenticationStatus] = useState<AuthenticationStatus>('not_authenticated');
|
const [authenticationStatus, setAuthenticationStatus] = useState<AuthenticationStatus>('not_authenticated');
|
||||||
const [authKey, setAuthKey] = useState<string | null>(null);
|
const [authKey, setAuthKey] = useState<string | null>(null);
|
||||||
const [loading, setLoading] = useState<'' | 'cancel' | 'connect' | 'authenticate' | 'load-sheet'>('');
|
|
||||||
const [authLink, setAuthLink] = useState('');
|
const [authLink, setAuthLink] = useState('');
|
||||||
|
const [loading, setLoading] = useState<'' | 'cancel' | 'connect' | 'authenticate' | 'load-sheet'>('');
|
||||||
const [authError, setAuthError] = useState('');
|
const [authError, setAuthError] = useState('');
|
||||||
const [worksheetError, setWorksheetError] = useState('');
|
const [worksheetError, setWorksheetError] = useState('');
|
||||||
const pollTimeoutRef = useRef<number | null>(null);
|
const pollTimeoutRef = useRef<number | null>(null);
|
||||||
@@ -62,6 +64,7 @@ export default function GSheetSetup(props: GSheetSetupProps) {
|
|||||||
const loadWorksheetOptions = useCallback(
|
const loadWorksheetOptions = useCallback(
|
||||||
async (nextSheetId: string) => {
|
async (nextSheetId: string) => {
|
||||||
const worksheetOptions = await getWorksheetOptions(nextSheetId);
|
const worksheetOptions = await getWorksheetOptions(nextSheetId);
|
||||||
|
persistSheetId(nextSheetId);
|
||||||
onSheetLoaded(nextSheetId, worksheetOptions);
|
onSheetLoaded(nextSheetId, worksheetOptions);
|
||||||
setWorksheetError('');
|
setWorksheetError('');
|
||||||
},
|
},
|
||||||
@@ -71,6 +74,7 @@ export default function GSheetSetup(props: GSheetSetupProps) {
|
|||||||
const pollUntilAuthenticated = useCallback(
|
const pollUntilAuthenticated = useCallback(
|
||||||
async (attempts: number = 0) => {
|
async (attempts: number = 0) => {
|
||||||
clearPollTimeout();
|
clearPollTimeout();
|
||||||
|
if (closedByUser) return;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const result = await verifyAuthenticationStatus();
|
const result = await verifyAuthenticationStatus();
|
||||||
@@ -82,13 +86,16 @@ export default function GSheetSetup(props: GSheetSetupProps) {
|
|||||||
pollTimeoutRef.current = window.setTimeout(() => {
|
pollTimeoutRef.current = window.setTimeout(() => {
|
||||||
pollUntilAuthenticated(attempts + 1);
|
pollUntilAuthenticated(attempts + 1);
|
||||||
}, 2000);
|
}, 2000);
|
||||||
} else {
|
return; // Keep authKey for next poll
|
||||||
setLoading('');
|
|
||||||
}
|
}
|
||||||
|
// Polling timed out
|
||||||
|
setAuthKey(null);
|
||||||
|
setLoading('');
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (result.authenticated === 'authenticated') {
|
if (result.authenticated === 'authenticated' && result.sheetId) {
|
||||||
|
setLoading('load-sheet');
|
||||||
try {
|
try {
|
||||||
await loadWorksheetOptions(result.sheetId);
|
await loadWorksheetOptions(result.sheetId);
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
@@ -96,13 +103,15 @@ export default function GSheetSetup(props: GSheetSetupProps) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
setAuthKey(null);
|
||||||
setLoading('');
|
setLoading('');
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
setAuthError(maybeAxiosError(error));
|
setAuthError(maybeAxiosError(error));
|
||||||
|
setAuthKey(null);
|
||||||
setLoading('');
|
setLoading('');
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
[clearPollTimeout, loadWorksheetOptions],
|
[clearPollTimeout, loadWorksheetOptions, closedByUser],
|
||||||
);
|
);
|
||||||
|
|
||||||
/** check if the current session has been authenticated */
|
/** check if the current session has been authenticated */
|
||||||
@@ -150,7 +159,7 @@ export default function GSheetSetup(props: GSheetSetupProps) {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Requests connection to google auth
|
* Requests a device code from Google. The user can copy it before opening the browser.
|
||||||
*/
|
*/
|
||||||
const handleConnect = async () => {
|
const handleConnect = async () => {
|
||||||
if (!file) return;
|
if (!file) return;
|
||||||
@@ -171,7 +180,7 @@ export default function GSheetSetup(props: GSheetSetupProps) {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Open google auth
|
* Opens the Google verification page and starts polling for completion.
|
||||||
*/
|
*/
|
||||||
const handleAuthenticate = () => {
|
const handleAuthenticate = () => {
|
||||||
setLoading('authenticate');
|
setLoading('authenticate');
|
||||||
@@ -180,7 +189,6 @@ export default function GSheetSetup(props: GSheetSetupProps) {
|
|||||||
clearPollTimeout();
|
clearPollTimeout();
|
||||||
clearAuthFallbackTimeout();
|
clearAuthFallbackTimeout();
|
||||||
|
|
||||||
// open link and schedule a check for when the user focuses again
|
|
||||||
openLink(authLink);
|
openLink(authLink);
|
||||||
authFallbackTimeoutRef.current = window.setTimeout(() => {
|
authFallbackTimeoutRef.current = window.setTimeout(() => {
|
||||||
if (document.hasFocus()) {
|
if (document.hasFocus()) {
|
||||||
@@ -269,18 +277,19 @@ export default function GSheetSetup(props: GSheetSetupProps) {
|
|||||||
</Panel.ListGroup>
|
</Panel.ListGroup>
|
||||||
)}
|
)}
|
||||||
<Panel.ListGroup className={style.setupBlock}>
|
<Panel.ListGroup className={style.setupBlock}>
|
||||||
<Panel.Description>Enter ID of sheet to synchronise</Panel.Description>
|
<Panel.Description>Enter ID of sheet to synchronize</Panel.Description>
|
||||||
<Panel.Error>{worksheetError}</Panel.Error>
|
<Panel.Error>{worksheetError}</Panel.Error>
|
||||||
<Input
|
<Input
|
||||||
fluid
|
fluid
|
||||||
value={sheetId}
|
value={sheetId}
|
||||||
placeholder='Sheet ID'
|
placeholder='Sheet ID or Google Sheets URL'
|
||||||
onChange={(event) => {
|
onChange={(event) => {
|
||||||
setWorksheetError('');
|
setWorksheetError('');
|
||||||
setSheetId(event.target.value);
|
setSheetId(extractSheetId(event.target.value));
|
||||||
}}
|
}}
|
||||||
disabled={isLoading || canAuthenticate}
|
disabled={isLoading || canAuthenticate}
|
||||||
/>
|
/>
|
||||||
|
<div className={style.setupHint}>Paste a Google Sheets URL or the sheet ID from the URL bar.</div>
|
||||||
</Panel.ListGroup>
|
</Panel.ListGroup>
|
||||||
{isAuthenticated ? (
|
{isAuthenticated ? (
|
||||||
<Panel.ListGroup className={style.setupBlock}>
|
<Panel.ListGroup className={style.setupBlock}>
|
||||||
@@ -304,18 +313,16 @@ export default function GSheetSetup(props: GSheetSetupProps) {
|
|||||||
</Panel.ListGroup>
|
</Panel.ListGroup>
|
||||||
) : (
|
) : (
|
||||||
<Panel.ListGroup className={style.setupBlock}>
|
<Panel.ListGroup className={style.setupBlock}>
|
||||||
<Panel.Description>Authenticate this Ontime session with Google</Panel.Description>
|
<Panel.Description>Copy the device code, then authenticate with Google</Panel.Description>
|
||||||
<Panel.InlineElements wrap='wrap' className={style.setupActions}>
|
<Panel.InlineElements wrap='wrap' className={style.setupActions}>
|
||||||
{isAuthenticating && <span>Authenticating...</span>}
|
{isAuthenticating && <span>Authenticating...</span>}
|
||||||
<CopyTag copyValue={authKey ?? ''} disabled={!canAuthenticate}>
|
<CopyTag copyValue={authKey ?? ''}>{authKey}</CopyTag>
|
||||||
{authKey ? authKey : 'Upload files to generate Auth Key'}
|
<Button onClick={handleAuthenticate} disabled={isLoading} loading={loading === 'authenticate'}>
|
||||||
</CopyTag>
|
|
||||||
<Button onClick={handleAuthenticate} disabled={!canAuthenticate}>
|
|
||||||
<IoShieldCheckmarkOutline />
|
<IoShieldCheckmarkOutline />
|
||||||
Authenticate
|
Authenticate
|
||||||
</Button>
|
</Button>
|
||||||
</Panel.InlineElements>
|
</Panel.InlineElements>
|
||||||
<div className={style.setupHint}>Open the browser prompt, complete the code flow, then come back here.</div>
|
<div className={style.setupHint}>Copy the code, then open the browser prompt to complete the flow.</div>
|
||||||
</Panel.ListGroup>
|
</Panel.ListGroup>
|
||||||
)}
|
)}
|
||||||
</Panel.Section>
|
</Panel.Section>
|
||||||
|
|||||||
+7
@@ -25,6 +25,13 @@
|
|||||||
margin-top: 1rem;
|
margin-top: 1rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.finishActions {
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
justify-content: center;
|
||||||
|
gap: 0.5rem;
|
||||||
|
}
|
||||||
|
|
||||||
.sourceGrid {
|
.sourceGrid {
|
||||||
display: grid;
|
display: grid;
|
||||||
grid-template-columns: repeat(2, minmax(0, 1fr));
|
grid-template-columns: repeat(2, minmax(0, 1fr));
|
||||||
|
|||||||
+84
-28
@@ -1,4 +1,6 @@
|
|||||||
import type {
|
import type {
|
||||||
|
ImportedFields,
|
||||||
|
RundownImportMode,
|
||||||
SpreadsheetPreviewResponse,
|
SpreadsheetPreviewResponse,
|
||||||
SpreadsheetWorksheetMetadata,
|
SpreadsheetWorksheetMetadata,
|
||||||
SpreadsheetWorksheetOptions,
|
SpreadsheetWorksheetOptions,
|
||||||
@@ -6,6 +8,7 @@ import type {
|
|||||||
import { getErrorMessage, ImportMap } from 'ontime-utils';
|
import { getErrorMessage, ImportMap } from 'ontime-utils';
|
||||||
import { ChangeEvent, useCallback, useRef, useState } from 'react';
|
import { ChangeEvent, useCallback, useRef, useState } from 'react';
|
||||||
import { IoCloudOutline, IoDownloadOutline } from 'react-icons/io5';
|
import { IoCloudOutline, IoDownloadOutline } from 'react-icons/io5';
|
||||||
|
import { useNavigate } from 'react-router';
|
||||||
|
|
||||||
import {
|
import {
|
||||||
getWorksheetMetadata as getExcelWorksheetMetadata,
|
getWorksheetMetadata as getExcelWorksheetMetadata,
|
||||||
@@ -22,7 +25,7 @@ import Info from '../../../../../common/components/info/Info';
|
|||||||
import ExternalLink from '../../../../../common/components/link/external-link/ExternalLink';
|
import ExternalLink from '../../../../../common/components/link/external-link/ExternalLink';
|
||||||
import Modal from '../../../../../common/components/modal/Modal';
|
import Modal from '../../../../../common/components/modal/Modal';
|
||||||
import useRundown from '../../../../../common/hooks-query/useRundown';
|
import useRundown from '../../../../../common/hooks-query/useRundown';
|
||||||
import { validateExcelImport } from '../../../../../common/utils/uploadUtils';
|
import { removeFileExtension, validateExcelImport } from '../../../../../common/utils/uploadUtils';
|
||||||
import * as Panel from '../../../panel-utils/PanelUtils';
|
import * as Panel from '../../../panel-utils/PanelUtils';
|
||||||
import GSheetSetup from './GSheetSetup';
|
import GSheetSetup from './GSheetSetup';
|
||||||
import SheetImportEditor from './sheet-import/SheetImportEditor';
|
import SheetImportEditor from './sheet-import/SheetImportEditor';
|
||||||
@@ -35,14 +38,18 @@ const googleSheetDocsUrl = 'https://docs.getontime.no/features/import-spreadshee
|
|||||||
type ActiveSource =
|
type ActiveSource =
|
||||||
| {
|
| {
|
||||||
kind: 'excel';
|
kind: 'excel';
|
||||||
|
fileName: string;
|
||||||
worksheetNames: string[];
|
worksheetNames: string[];
|
||||||
initialWorksheetMetadata: SpreadsheetWorksheetMetadata | null;
|
initialWorksheetMetadata: SpreadsheetWorksheetMetadata | null;
|
||||||
|
closedByUser: boolean;
|
||||||
}
|
}
|
||||||
| {
|
| {
|
||||||
kind: 'gsheet';
|
kind: 'gsheet';
|
||||||
sheetId: string;
|
sheetId: string;
|
||||||
worksheetNames: string[];
|
worksheetNames: string[];
|
||||||
initialWorksheetMetadata: SpreadsheetWorksheetMetadata | null;
|
initialWorksheetMetadata: SpreadsheetWorksheetMetadata | null;
|
||||||
|
title: string;
|
||||||
|
closedByUser: boolean;
|
||||||
};
|
};
|
||||||
|
|
||||||
export default function SourcesPanel() {
|
export default function SourcesPanel() {
|
||||||
@@ -50,9 +57,11 @@ export default function SourcesPanel() {
|
|||||||
const [error, setError] = useState('');
|
const [error, setError] = useState('');
|
||||||
const [hasFile, setHasFile] = useState<'none' | 'loading' | 'done'>('none');
|
const [hasFile, setHasFile] = useState<'none' | 'loading' | 'done'>('none');
|
||||||
const [activeSource, setActiveSource] = useState<ActiveSource | null>(null);
|
const [activeSource, setActiveSource] = useState<ActiveSource | null>(null);
|
||||||
|
const [completedRundownTitle, setCompletedRundownTitle] = useState('');
|
||||||
|
|
||||||
const { data: currentRundown } = useRundown();
|
const { data: currentRundown } = useRundown();
|
||||||
const { importRundown } = useSpreadsheetImport();
|
const { applyImport } = useSpreadsheetImport();
|
||||||
|
const navigate = useNavigate();
|
||||||
|
|
||||||
const fileInputRef = useRef<HTMLInputElement>(null);
|
const fileInputRef = useRef<HTMLInputElement>(null);
|
||||||
|
|
||||||
@@ -71,8 +80,10 @@ export default function SourcesPanel() {
|
|||||||
const worksheetOptions = await uploadExcel(fileToUpload);
|
const worksheetOptions = await uploadExcel(fileToUpload);
|
||||||
setActiveSource({
|
setActiveSource({
|
||||||
kind: 'excel',
|
kind: 'excel',
|
||||||
|
fileName: fileToUpload.name,
|
||||||
worksheetNames: worksheetOptions.worksheets,
|
worksheetNames: worksheetOptions.worksheets,
|
||||||
initialWorksheetMetadata: worksheetOptions.metadata,
|
initialWorksheetMetadata: worksheetOptions.metadata,
|
||||||
|
closedByUser: false,
|
||||||
});
|
});
|
||||||
setImportFlow('excel');
|
setImportFlow('excel');
|
||||||
setHasFile('done');
|
setHasFile('done');
|
||||||
@@ -93,6 +104,7 @@ export default function SourcesPanel() {
|
|||||||
setHasFile('none');
|
setHasFile('none');
|
||||||
setActiveSource(null);
|
setActiveSource(null);
|
||||||
setError('');
|
setError('');
|
||||||
|
setCompletedRundownTitle('');
|
||||||
};
|
};
|
||||||
|
|
||||||
const openGSheetFlow = () => {
|
const openGSheetFlow = () => {
|
||||||
@@ -106,32 +118,50 @@ export default function SourcesPanel() {
|
|||||||
};
|
};
|
||||||
|
|
||||||
const cancelImportFlow = () => {
|
const cancelImportFlow = () => {
|
||||||
resetFlow();
|
if (activeSource && activeSource.kind === 'gsheet') {
|
||||||
|
// Return to GSheetSetup so the user can change the sheet ID or revoke auth
|
||||||
|
setActiveSource({ ...activeSource, closedByUser: true });
|
||||||
|
setError('');
|
||||||
|
} else {
|
||||||
|
resetFlow();
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
const handleFinished = () => {
|
const handleFinished = (rundownTitle: string) => {
|
||||||
setImportFlow('finished');
|
setImportFlow('finished');
|
||||||
setHasFile('none');
|
setHasFile('none');
|
||||||
setActiveSource(null);
|
setActiveSource(null);
|
||||||
setError('');
|
setError('');
|
||||||
|
setCompletedRundownTitle(rundownTitle);
|
||||||
};
|
};
|
||||||
|
|
||||||
const handleApplyImport = async (preview: SpreadsheetPreviewResponse) => {
|
const handleApplyImport = async (
|
||||||
|
preview: SpreadsheetPreviewResponse,
|
||||||
|
mode: RundownImportMode,
|
||||||
|
newRundownTitle: string,
|
||||||
|
providedFields: ImportedFields,
|
||||||
|
) => {
|
||||||
|
if (mode === 'new') {
|
||||||
|
const title = newRundownTitle.trim() || preview.rundown.title;
|
||||||
|
await applyImport({ mode: 'new', rundown: { ...preview.rundown, title }, customFields: preview.customFields });
|
||||||
|
handleFinished(title);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
if (!currentRundown) {
|
if (!currentRundown) {
|
||||||
throw new Error('No current rundown loaded');
|
throw new Error('No current rundown loaded');
|
||||||
}
|
}
|
||||||
|
|
||||||
await importRundown(
|
// override or merge into the current rundown; merge uses providedFields to know which columns
|
||||||
{
|
// the sheet supplied so matched events keep the rest (e.g. automations)
|
||||||
[currentRundown.id]: {
|
await applyImport({
|
||||||
...preview.rundown,
|
mode,
|
||||||
id: currentRundown.id,
|
targetRundownId: currentRundown.id,
|
||||||
title: currentRundown.title,
|
rundown: preview.rundown,
|
||||||
},
|
customFields: preview.customFields,
|
||||||
},
|
providedFields,
|
||||||
preview.customFields,
|
});
|
||||||
);
|
handleFinished(currentRundown.title);
|
||||||
handleFinished();
|
|
||||||
};
|
};
|
||||||
|
|
||||||
const loadWorksheetMetadata = useCallback(
|
const loadWorksheetMetadata = useCallback(
|
||||||
@@ -177,25 +207,39 @@ export default function SourcesPanel() {
|
|||||||
sheetId,
|
sheetId,
|
||||||
worksheetNames: worksheetOptions.worksheets,
|
worksheetNames: worksheetOptions.worksheets,
|
||||||
initialWorksheetMetadata: worksheetOptions.metadata,
|
initialWorksheetMetadata: worksheetOptions.metadata,
|
||||||
|
title: worksheetOptions.title ?? '',
|
||||||
|
closedByUser: false,
|
||||||
});
|
});
|
||||||
}, []);
|
}, []);
|
||||||
|
|
||||||
|
const closedByUser = activeSource?.closedByUser ?? false;
|
||||||
const isGSheetFlow = importFlow === 'gsheet';
|
const isGSheetFlow = importFlow === 'gsheet';
|
||||||
const showInput = importFlow === 'none';
|
const showInput = importFlow === 'none';
|
||||||
const showCompleted = importFlow === 'finished';
|
const showCompleted = importFlow === 'finished';
|
||||||
const showAuth = isGSheetFlow && activeSource === null;
|
|
||||||
const showImportWorkspace = activeSource !== null;
|
const showImportWorkspace = activeSource !== null && !closedByUser;
|
||||||
const importModalTitle = activeSource?.kind === 'excel' ? 'Import spreadsheet' : 'Synchronise with Google Sheet';
|
const importModalTitle = (() => {
|
||||||
|
if (!activeSource) return '';
|
||||||
|
if (activeSource.kind === 'excel') return 'Import spreadsheet';
|
||||||
|
return activeSource.title ? `Sync: ${activeSource.title}` : 'Synchronize with Google Sheet';
|
||||||
|
})();
|
||||||
const sourceKey = (() => {
|
const sourceKey = (() => {
|
||||||
if (!activeSource) return null;
|
if (!activeSource) return null;
|
||||||
if (activeSource.kind === 'excel') return 'excel';
|
if (activeSource.kind === 'excel') return 'excel';
|
||||||
return `gsheet:${activeSource.sheetId}`;
|
return `gsheet:${activeSource.sheetId}`;
|
||||||
})();
|
})();
|
||||||
|
// suggested name when importing into a new rundown: the spreadsheet file name (without extension)
|
||||||
|
// for Excel, or the document title for Google Sheets
|
||||||
|
const spreadsheetName = (() => {
|
||||||
|
if (!activeSource) return '';
|
||||||
|
if (activeSource.kind === 'excel') return removeFileExtension(activeSource.fileName);
|
||||||
|
return activeSource.title;
|
||||||
|
})();
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Panel.Section>
|
<Panel.Section>
|
||||||
<Panel.Card>
|
<Panel.Card>
|
||||||
<Panel.SubHeader>Synchronise your rundown with an external source</Panel.SubHeader>
|
<Panel.SubHeader>Synchronize your rundown with an external source</Panel.SubHeader>
|
||||||
{error && <Panel.Error>{error}</Panel.Error>}
|
{error && <Panel.Error>{error}</Panel.Error>}
|
||||||
{showInput && (
|
{showInput && (
|
||||||
<div className={style.introStack}>
|
<div className={style.introStack}>
|
||||||
@@ -233,7 +277,7 @@ export default function SourcesPanel() {
|
|||||||
</section>
|
</section>
|
||||||
<section className={style.sourceCard}>
|
<section className={style.sourceCard}>
|
||||||
<div className={style.sourceHeader}>
|
<div className={style.sourceHeader}>
|
||||||
<h4 className={style.sourceTitle}>Synchronise with Google</h4>
|
<h4 className={style.sourceTitle}>Synchronize with Google</h4>
|
||||||
</div>
|
</div>
|
||||||
<p className={style.sourceDescription}>
|
<p className={style.sourceDescription}>
|
||||||
Connect a Google account once, then load any sheet by ID and keep the import flow inside Ontime.
|
Connect a Google account once, then load any sheet by ID and keep the import flow inside Ontime.
|
||||||
@@ -241,7 +285,7 @@ export default function SourcesPanel() {
|
|||||||
<div className={style.sourceMeta}>Requires Google OAuth client credentials</div>
|
<div className={style.sourceMeta}>Requires Google OAuth client credentials</div>
|
||||||
<Button variant='primary' size='large' fluid onClick={openGSheetFlow} disabled={hasFile !== 'none'}>
|
<Button variant='primary' size='large' fluid onClick={openGSheetFlow} disabled={hasFile !== 'none'}>
|
||||||
<IoCloudOutline />
|
<IoCloudOutline />
|
||||||
Synchronise with Google
|
Synchronize with Google
|
||||||
</Button>
|
</Button>
|
||||||
</section>
|
</section>
|
||||||
</div>
|
</div>
|
||||||
@@ -250,14 +294,25 @@ export default function SourcesPanel() {
|
|||||||
{showCompleted && (
|
{showCompleted && (
|
||||||
<div className={style.finishSection}>
|
<div className={style.finishSection}>
|
||||||
<span className={style.finishBadge}>Import complete</span>
|
<span className={style.finishBadge}>Import complete</span>
|
||||||
<div className={style.finishTitle}>Spreadsheet data applied.</div>
|
<div className={style.finishTitle}>
|
||||||
<div className={style.finishDescription}>You can close this flow or start another import.</div>
|
Spreadsheet data applied to {completedRundownTitle || 'your rundown'}.
|
||||||
<Button variant='subtle-white' onClick={resetFlow}>
|
</div>
|
||||||
Reset flow
|
<div className={style.finishDescription}>
|
||||||
</Button>
|
Review the imported rundown in the editor or start another import.
|
||||||
|
</div>
|
||||||
|
<div className={style.finishActions}>
|
||||||
|
<Button variant='primary' onClick={() => navigate('/editor')}>
|
||||||
|
Open editor
|
||||||
|
</Button>
|
||||||
|
<Button variant='subtle-white' onClick={resetFlow}>
|
||||||
|
Import another
|
||||||
|
</Button>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
)}
|
)}
|
||||||
{showAuth && <GSheetSetup onCancel={cancelGSheetFlow} onSheetLoaded={handleSheetLoaded} />}
|
{isGSheetFlow && (
|
||||||
|
<GSheetSetup onCancel={cancelGSheetFlow} onSheetLoaded={handleSheetLoaded} closedByUser={closedByUser} />
|
||||||
|
)}
|
||||||
<Modal
|
<Modal
|
||||||
isOpen={showImportWorkspace}
|
isOpen={showImportWorkspace}
|
||||||
title={importModalTitle}
|
title={importModalTitle}
|
||||||
@@ -268,6 +323,7 @@ export default function SourcesPanel() {
|
|||||||
bodyElements={
|
bodyElements={
|
||||||
<SheetImportEditor
|
<SheetImportEditor
|
||||||
sourceKey={sourceKey ?? 'spreadsheet'}
|
sourceKey={sourceKey ?? 'spreadsheet'}
|
||||||
|
defaultRundownName={spreadsheetName}
|
||||||
worksheetNames={activeSource?.worksheetNames ?? []}
|
worksheetNames={activeSource?.worksheetNames ?? []}
|
||||||
initialMetadata={activeSource?.initialWorksheetMetadata ?? null}
|
initialMetadata={activeSource?.initialWorksheetMetadata ?? null}
|
||||||
loadMetadata={loadWorksheetMetadata}
|
loadMetadata={loadWorksheetMetadata}
|
||||||
|
|||||||
+45
@@ -0,0 +1,45 @@
|
|||||||
|
import { describe, expect, it } from 'vitest';
|
||||||
|
|
||||||
|
import { extractSheetId } from '../gsheetUtils';
|
||||||
|
|
||||||
|
describe('extractSheetId()', () => {
|
||||||
|
it('extracts the ID from a full Google Sheets URL', () => {
|
||||||
|
const url = 'https://docs.google.com/spreadsheets/d/1aBcDeFgHiJkLmNoPqRsTuVwXyZ/edit#gid=0';
|
||||||
|
expect(extractSheetId(url)).toBe('1aBcDeFgHiJkLmNoPqRsTuVwXyZ');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('extracts the ID when the URL has no trailing path', () => {
|
||||||
|
expect(extractSheetId('https://docs.google.com/spreadsheets/d/abc123')).toBe('abc123');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('handles IDs with hyphens and underscores', () => {
|
||||||
|
const url = 'https://docs.google.com/spreadsheets/d/1a-B_c2/edit';
|
||||||
|
expect(extractSheetId(url)).toBe('1a-B_c2');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns a raw sheet ID unchanged', () => {
|
||||||
|
expect(extractSheetId('1aBcDeFgHiJkLmNoPqRsTuVwXyZ')).toBe('1aBcDeFgHiJkLmNoPqRsTuVwXyZ');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('trims whitespace from the input', () => {
|
||||||
|
expect(extractSheetId(' 1aBcDeFg ')).toBe('1aBcDeFg');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('trims whitespace from a pasted URL', () => {
|
||||||
|
const url = ' https://docs.google.com/spreadsheets/d/1aBcDeFg/edit ';
|
||||||
|
expect(extractSheetId(url)).toBe('1aBcDeFg');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('strips query params from a raw ID', () => {
|
||||||
|
expect(extractSheetId('1aBcDeFgHiJkLmNoPqRsTuVwXyZ?edit=1')).toBe('1aBcDeFgHiJkLmNoPqRsTuVwXyZ');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('strips fragment from a raw ID', () => {
|
||||||
|
expect(extractSheetId('1aBcDeFg#gid=0')).toBe('1aBcDeFg');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns empty string for empty input', () => {
|
||||||
|
expect(extractSheetId('')).toBe('');
|
||||||
|
expect(extractSheetId(' ')).toBe('');
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
import { makeStageKey } from '../../../../../common/utils/localStorage';
|
||||||
|
|
||||||
|
// Matches the document ID segment from a Google Sheets URL:
|
||||||
|
// https://docs.google.com/spreadsheets/d/{ID}/edit#gid=0
|
||||||
|
// ^^^^ captured group
|
||||||
|
// IDs consist of alphanumeric chars, hyphens, and underscores.
|
||||||
|
const sheetIdPattern = /\/spreadsheets\/d\/([a-zA-Z0-9_-]+)/;
|
||||||
|
const lastSheetIdKey = makeStageKey('gsheet:lastSheetId');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extracts a Google Sheet ID from a full URL, or returns the raw input if it doesn't match.
|
||||||
|
*/
|
||||||
|
export function extractSheetId(input: string): string {
|
||||||
|
const trimmed = input.trim();
|
||||||
|
const match = trimmed.match(sheetIdPattern);
|
||||||
|
if (match) return match[1];
|
||||||
|
|
||||||
|
// Strip query params (?...) and fragments (#...) in case the user
|
||||||
|
// pasted a partial URL or an ID with trailing junk like "abc123?edit=1"
|
||||||
|
return trimmed.split(/[?#]/)[0];
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getPersistedSheetId(): string {
|
||||||
|
return localStorage.getItem(lastSheetIdKey) ?? '';
|
||||||
|
}
|
||||||
|
|
||||||
|
export function persistSheetId(sheetId: string) {
|
||||||
|
localStorage.setItem(lastSheetIdKey, sheetId);
|
||||||
|
}
|
||||||
+55
@@ -0,0 +1,55 @@
|
|||||||
|
import type { RundownImportMode, SpreadsheetPreviewResponse } from 'ontime-types';
|
||||||
|
import { isOntimeEvent, isPlayableEvent, Playback } from 'ontime-types';
|
||||||
|
import { useEffect, useState } from 'react';
|
||||||
|
|
||||||
|
import Button from '../../../../../../common/components/buttons/Button';
|
||||||
|
import { usePlayback, useSelectedEventId } from '../../../../../../common/hooks/useSocket';
|
||||||
|
|
||||||
|
interface ApplyImportButtonProps {
|
||||||
|
preview: SpreadsheetPreviewResponse | null;
|
||||||
|
mode: RundownImportMode;
|
||||||
|
disabled: boolean;
|
||||||
|
loading: boolean;
|
||||||
|
onApply: () => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Apply action for the spreadsheet import.
|
||||||
|
* Subscribes to playback state on its own so playback updates do not re-render the whole editor.
|
||||||
|
* Requires a second click to confirm when applying would stop a running playback.
|
||||||
|
*/
|
||||||
|
export default function ApplyImportButton({ preview, mode, disabled, loading, onApply }: ApplyImportButtonProps) {
|
||||||
|
const playback = usePlayback();
|
||||||
|
const loadedEventId = useSelectedEventId();
|
||||||
|
|
||||||
|
// the loaded (playing) event loses its playback unless it still exists as a playable event after the import
|
||||||
|
const loadedEntry = loadedEventId ? preview?.rundown.entries[loadedEventId] : undefined;
|
||||||
|
const willLoadedEventBeOverriden = !(
|
||||||
|
loadedEntry !== undefined &&
|
||||||
|
isOntimeEvent(loadedEntry) &&
|
||||||
|
isPlayableEvent(loadedEntry)
|
||||||
|
);
|
||||||
|
|
||||||
|
// applying stops playback when creating a new rundown, or when the playing event does not survive
|
||||||
|
const willStopPlayback = playback !== Playback.Stop && (mode === 'new' || willLoadedEventBeOverriden);
|
||||||
|
|
||||||
|
// two-step confirmation before applying an import that stops playback
|
||||||
|
const [confirmStop, setConfirmStop] = useState(false);
|
||||||
|
useEffect(() => {
|
||||||
|
setConfirmStop(false);
|
||||||
|
}, [mode, preview]);
|
||||||
|
|
||||||
|
const handleClick = () => {
|
||||||
|
if (willStopPlayback && !confirmStop) {
|
||||||
|
setConfirmStop(true);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
onApply();
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Button variant='primary' onClick={handleClick} disabled={disabled} loading={loading}>
|
||||||
|
{willStopPlayback && confirmStop ? 'Confirm — stop playback & apply import' : 'Apply import'}
|
||||||
|
</Button>
|
||||||
|
);
|
||||||
|
}
|
||||||
+1
-1
@@ -16,7 +16,7 @@ export function getWarningText(warning: MappingWarning): string {
|
|||||||
case 'invalid-name':
|
case 'invalid-name':
|
||||||
return 'Column cannot be converted into an Ontime field name';
|
return 'Column cannot be converted into an Ontime field name';
|
||||||
case 'name-collision':
|
case 'name-collision':
|
||||||
return 'Column name resolves to a duplicate column';
|
return 'Column name resolves to a duplicate Ontime field';
|
||||||
default:
|
default:
|
||||||
return '';
|
return '';
|
||||||
}
|
}
|
||||||
|
|||||||
+9
@@ -33,6 +33,11 @@
|
|||||||
white-space: nowrap;
|
white-space: nowrap;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.importModeTrigger {
|
||||||
|
min-width: 12rem;
|
||||||
|
justify-content: space-between;
|
||||||
|
}
|
||||||
|
|
||||||
.addColumnTrigger {
|
.addColumnTrigger {
|
||||||
justify-content: center;
|
justify-content: center;
|
||||||
white-space: nowrap;
|
white-space: nowrap;
|
||||||
@@ -87,6 +92,10 @@
|
|||||||
font-weight: 600;
|
font-weight: 600;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.toolbarWarning {
|
||||||
|
color: $orange-400;
|
||||||
|
}
|
||||||
|
|
||||||
.mappingPaneTitle {
|
.mappingPaneTitle {
|
||||||
align-self: center;
|
align-self: center;
|
||||||
}
|
}
|
||||||
|
|||||||
+133
-31
@@ -1,10 +1,20 @@
|
|||||||
import type { SpreadsheetPreviewResponse, SpreadsheetWorksheetMetadata } from 'ontime-types';
|
import type {
|
||||||
|
ImportedFields,
|
||||||
|
RundownImportMode,
|
||||||
|
SpreadsheetPreviewResponse,
|
||||||
|
SpreadsheetWorksheetMetadata,
|
||||||
|
} from 'ontime-types';
|
||||||
import type { ImportMap } from 'ontime-utils';
|
import type { ImportMap } from 'ontime-utils';
|
||||||
import { IoArrowUpOutline, IoEye } from 'react-icons/io5';
|
import { useMemo } from 'react';
|
||||||
|
import { IoArrowUpOutline, IoCheckmark, IoChevronDown, IoEye, IoWarningOutline } from 'react-icons/io5';
|
||||||
|
|
||||||
import Button from '../../../../../../common/components/buttons/Button';
|
import Button from '../../../../../../common/components/buttons/Button';
|
||||||
|
import { DropdownMenu, DropdownMenuOption } from '../../../../../../common/components/dropdown-menu/DropdownMenu';
|
||||||
|
import Input from '../../../../../../common/components/input/input/Input';
|
||||||
import Select from '../../../../../../common/components/select/Select';
|
import Select from '../../../../../../common/components/select/Select';
|
||||||
import * as Panel from '../../../../panel-utils/PanelUtils';
|
import * as Panel from '../../../../panel-utils/PanelUtils';
|
||||||
|
import ApplyImportButton from './ApplyImportButton';
|
||||||
|
import { isIdColumnMapped } from './importMapUtils';
|
||||||
import PreviewTable from './preview/PreviewTable';
|
import PreviewTable from './preview/PreviewTable';
|
||||||
import SheetImportMappingPane from './SheetImportMappingPane';
|
import SheetImportMappingPane from './SheetImportMappingPane';
|
||||||
import { useSheetImportForm } from './useSheetImportForm';
|
import { useSheetImportForm } from './useSheetImportForm';
|
||||||
@@ -13,17 +23,46 @@ import style from './SheetImportEditor.module.scss';
|
|||||||
|
|
||||||
interface SheetImportEditorProps {
|
interface SheetImportEditorProps {
|
||||||
sourceKey: string;
|
sourceKey: string;
|
||||||
|
defaultRundownName: string;
|
||||||
worksheetNames: string[];
|
worksheetNames: string[];
|
||||||
initialMetadata: SpreadsheetWorksheetMetadata | null;
|
initialMetadata: SpreadsheetWorksheetMetadata | null;
|
||||||
loadMetadata: (worksheet: string) => Promise<SpreadsheetWorksheetMetadata>;
|
loadMetadata: (worksheet: string) => Promise<SpreadsheetWorksheetMetadata>;
|
||||||
previewImport: (importMap: ImportMap) => Promise<SpreadsheetPreviewResponse>;
|
previewImport: (importMap: ImportMap) => Promise<SpreadsheetPreviewResponse>;
|
||||||
onApply: (preview: SpreadsheetPreviewResponse) => Promise<void>;
|
onApply: (
|
||||||
|
preview: SpreadsheetPreviewResponse,
|
||||||
|
mode: RundownImportMode,
|
||||||
|
newRundownTitle: string,
|
||||||
|
providedFields: ImportedFields,
|
||||||
|
) => Promise<void>;
|
||||||
onCancel: () => void;
|
onCancel: () => void;
|
||||||
onExport?: (importMap: ImportMap) => Promise<void>;
|
onExport?: (importMap: ImportMap) => Promise<void>;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const importModeOptions: Array<{
|
||||||
|
value: RundownImportMode;
|
||||||
|
label: string;
|
||||||
|
description: string;
|
||||||
|
}> = [
|
||||||
|
{
|
||||||
|
value: 'override',
|
||||||
|
label: 'Replace current rundown',
|
||||||
|
description: 'Spreadsheet data completely replaces current rundown',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
value: 'merge',
|
||||||
|
label: 'Merge with current rundown',
|
||||||
|
description: 'Merge entries referencing their IDs, entries not present in spreadsheet rundown are deleted',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
value: 'new',
|
||||||
|
label: 'New rundown',
|
||||||
|
description: 'Create a new rundown to import the data into. Loads the new rundown',
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
export default function SheetImportEditor({
|
export default function SheetImportEditor({
|
||||||
sourceKey,
|
sourceKey,
|
||||||
|
defaultRundownName,
|
||||||
worksheetNames,
|
worksheetNames,
|
||||||
initialMetadata,
|
initialMetadata,
|
||||||
loadMetadata,
|
loadMetadata,
|
||||||
@@ -49,11 +88,16 @@ export default function SheetImportEditor({
|
|||||||
isBusy,
|
isBusy,
|
||||||
canPreview,
|
canPreview,
|
||||||
displayError,
|
displayError,
|
||||||
|
importMode,
|
||||||
|
setImportMode,
|
||||||
|
newRundownTitle,
|
||||||
|
setNewRundownTitle,
|
||||||
handlePreviewSubmit,
|
handlePreviewSubmit,
|
||||||
handleExportSubmit,
|
handleExportSubmit,
|
||||||
handleApply,
|
handleApply,
|
||||||
} = useSheetImportForm({
|
} = useSheetImportForm({
|
||||||
sourceKey,
|
sourceKey,
|
||||||
|
defaultRundownName,
|
||||||
worksheetNames,
|
worksheetNames,
|
||||||
initialMetadata,
|
initialMetadata,
|
||||||
loadMetadata,
|
loadMetadata,
|
||||||
@@ -62,6 +106,19 @@ export default function SheetImportEditor({
|
|||||||
onExport,
|
onExport,
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const selectedImportMode = importModeOptions.find((option) => option.value === importMode) ?? importModeOptions[0];
|
||||||
|
const importModeItems = useMemo<DropdownMenuOption[]>(
|
||||||
|
() =>
|
||||||
|
importModeOptions.map((option) => ({
|
||||||
|
type: 'item',
|
||||||
|
label: option.label,
|
||||||
|
description: option.description,
|
||||||
|
icon: importMode === option.value ? IoCheckmark : undefined,
|
||||||
|
onClick: () => setImportMode(option.value),
|
||||||
|
})),
|
||||||
|
[importMode, setImportMode],
|
||||||
|
);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Panel.Section as='form' id='spreadsheet-import-workspace' className={style.editor} onSubmit={handlePreviewSubmit}>
|
<Panel.Section as='form' id='spreadsheet-import-workspace' className={style.editor} onSubmit={handlePreviewSubmit}>
|
||||||
<Panel.InlineElements align='apart' wrap='wrap' className={style.editorToolbar}>
|
<Panel.InlineElements align='apart' wrap='wrap' className={style.editorToolbar}>
|
||||||
@@ -75,7 +132,16 @@ export default function SheetImportEditor({
|
|||||||
}
|
}
|
||||||
/>
|
/>
|
||||||
</label>
|
</label>
|
||||||
{toolbarStatus && <Panel.Description>{toolbarStatus}</Panel.Description>}
|
{toolbarStatus && (
|
||||||
|
<Panel.Description>
|
||||||
|
{toolbarStatus.entries === '–'
|
||||||
|
? 'No import preview yet'
|
||||||
|
: `${toolbarStatus.entries} entries · ${toolbarStatus.groups} groups · ${toolbarStatus.milestones} milestones · ${toolbarStatus.start}–${toolbarStatus.end} · ${toolbarStatus.duration}`}
|
||||||
|
{toolbarStatus.warnings > 0 && (
|
||||||
|
<span className={style.toolbarWarning}> · {toolbarStatus.warnings} warnings</span>
|
||||||
|
)}
|
||||||
|
</Panel.Description>
|
||||||
|
)}
|
||||||
</Panel.InlineElements>
|
</Panel.InlineElements>
|
||||||
|
|
||||||
<div className={style.editorBody}>
|
<div className={style.editorBody}>
|
||||||
@@ -93,13 +159,19 @@ export default function SheetImportEditor({
|
|||||||
|
|
||||||
<section className={style.previewPane}>
|
<section className={style.previewPane}>
|
||||||
<div className={style.previewPaneHeader}>
|
<div className={style.previewPaneHeader}>
|
||||||
<span className={style.previewPaneTitle}>Import preview</span>
|
<div className={style.previewPaneHeading}>
|
||||||
|
<span className={style.previewPaneTitle}>Import preview</span>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div className={style.tableShell}>
|
<div className={style.tableShell}>
|
||||||
<PreviewTable
|
<PreviewTable
|
||||||
preview={state.preview}
|
preview={state.preview}
|
||||||
columnLabels={columnLabels}
|
columnLabels={columnLabels}
|
||||||
|
canRefresh={canPreview}
|
||||||
isLoadingMetadata={isLoadingMetadata}
|
isLoadingMetadata={isLoadingMetadata}
|
||||||
|
isRefreshing={state.loading === 'preview'}
|
||||||
|
needsPreviewRefresh={state.needsPreviewRefresh}
|
||||||
|
onRefresh={handlePreviewSubmit}
|
||||||
worksheetHeaders={worksheetHeaders}
|
worksheetHeaders={worksheetHeaders}
|
||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
@@ -107,33 +179,63 @@ export default function SheetImportEditor({
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
{displayError && <Panel.Error>{displayError}</Panel.Error>}
|
{displayError && <Panel.Error>{displayError}</Panel.Error>}
|
||||||
<Panel.InlineElements align='end' wrap='wrap' className={style.editorFooter}>
|
{importMode === 'merge' && !isIdColumnMapped(values) && (
|
||||||
<Button onClick={onCancel} disabled={isBusy}>
|
<Panel.Description tone='warning'>
|
||||||
Cancel
|
<IoWarningOutline /> No ID column mapped — merge matches entries by ID, so it will behave like Replace. Export
|
||||||
</Button>
|
your rundown to a spreadsheet first to keep its IDs.
|
||||||
{onExport && (
|
</Panel.Description>
|
||||||
<Button onClick={handleExportSubmit} disabled={!canPreview} loading={state.loading === 'export'}>
|
)}
|
||||||
<IoArrowUpOutline />
|
<Panel.InlineElements align='apart' wrap='wrap' className={style.editorFooter}>
|
||||||
Export
|
<Panel.InlineElements wrap='wrap'>
|
||||||
|
<label className={style.worksheetControl}>
|
||||||
|
<span className={style.worksheetLabel}>Import mode</span>
|
||||||
|
<DropdownMenu
|
||||||
|
render={<Button className={style.importModeTrigger} variant='subtle-white' />}
|
||||||
|
items={importModeItems}
|
||||||
|
>
|
||||||
|
{selectedImportMode.label}
|
||||||
|
<IoChevronDown />
|
||||||
|
</DropdownMenu>
|
||||||
|
</label>
|
||||||
|
{importMode === 'new' && (
|
||||||
|
<label className={style.worksheetControl}>
|
||||||
|
<span className={style.worksheetLabel}>New rundown name</span>
|
||||||
|
<Input
|
||||||
|
value={newRundownTitle}
|
||||||
|
onChange={(event) => setNewRundownTitle(event.target.value)}
|
||||||
|
placeholder={state.preview?.rundown.title || 'Imported rundown'}
|
||||||
|
aria-label='New rundown name'
|
||||||
|
/>
|
||||||
|
</label>
|
||||||
|
)}
|
||||||
|
</Panel.InlineElements>
|
||||||
|
<Panel.InlineElements wrap='wrap'>
|
||||||
|
<Button onClick={onCancel} disabled={isBusy}>
|
||||||
|
Cancel
|
||||||
</Button>
|
</Button>
|
||||||
)}
|
{onExport && (
|
||||||
<Button
|
<Button onClick={handleExportSubmit} disabled={!canPreview} loading={state.loading === 'export'}>
|
||||||
variant={state.preview ? undefined : 'primary'}
|
<IoArrowUpOutline />
|
||||||
onClick={handlePreviewSubmit}
|
Export
|
||||||
disabled={!canPreview}
|
</Button>
|
||||||
loading={state.loading === 'preview'}
|
)}
|
||||||
>
|
<Button
|
||||||
<IoEye />
|
variant={state.preview ? undefined : 'primary'}
|
||||||
Preview import
|
onClick={handlePreviewSubmit}
|
||||||
</Button>
|
disabled={!canPreview}
|
||||||
<Button
|
loading={state.loading === 'preview'}
|
||||||
variant='primary'
|
>
|
||||||
onClick={handleApply}
|
<IoEye />
|
||||||
disabled={!state.preview || isBusy}
|
Preview import
|
||||||
loading={state.loading === 'apply'}
|
</Button>
|
||||||
>
|
<ApplyImportButton
|
||||||
Apply import
|
preview={state.preview}
|
||||||
</Button>
|
mode={importMode}
|
||||||
|
disabled={!state.preview || isBusy}
|
||||||
|
loading={state.loading === 'apply'}
|
||||||
|
onApply={handleApply}
|
||||||
|
/>
|
||||||
|
</Panel.InlineElements>
|
||||||
</Panel.InlineElements>
|
</Panel.InlineElements>
|
||||||
</Panel.Section>
|
</Panel.Section>
|
||||||
);
|
);
|
||||||
|
|||||||
+1
-1
@@ -50,7 +50,7 @@ export default function SheetImportMappingPane({
|
|||||||
return (
|
return (
|
||||||
<section className={style.mappingPane}>
|
<section className={style.mappingPane}>
|
||||||
<Panel.InlineElements align='apart' className={style.mappingPaneHeader}>
|
<Panel.InlineElements align='apart' className={style.mappingPaneHeader}>
|
||||||
<span className={style.mappingPaneTitle}>Fields</span>
|
<span className={style.mappingPaneTitle}>Column mapping</span>
|
||||||
<Panel.InlineElements relation='inner' className={style.mappingPaneActions}>
|
<Panel.InlineElements relation='inner' className={style.mappingPaneActions}>
|
||||||
<Button className={style.addColumnTrigger} onClick={handleAddCustomField} disabled={isBusy}>
|
<Button className={style.addColumnTrigger} onClick={handleAddCustomField} disabled={isBusy}>
|
||||||
<IoAdd />
|
<IoAdd />
|
||||||
|
|||||||
+79
-4
@@ -1,15 +1,21 @@
|
|||||||
import { describe, expect, it } from 'vitest';
|
import { beforeEach, describe, expect, it } from 'vitest';
|
||||||
|
|
||||||
import {
|
import {
|
||||||
builtInFieldDefs,
|
builtInFieldDefs,
|
||||||
convertToImportMap,
|
convertToImportMap,
|
||||||
createDefaultFormValues,
|
createDefaultFormValues,
|
||||||
|
defaultImportMode,
|
||||||
getImportWarnings,
|
getImportWarnings,
|
||||||
|
getPersistedImportMode,
|
||||||
|
getProvidedImportFields,
|
||||||
getResolvedCustomFields,
|
getResolvedCustomFields,
|
||||||
|
isIdColumnMapped,
|
||||||
|
persistImportMode,
|
||||||
} from '../importMapUtils';
|
} from '../importMapUtils';
|
||||||
|
|
||||||
const cueIndex = builtInFieldDefs.findIndex((field) => field.label === 'Cue');
|
const cueIndex = builtInFieldDefs.findIndex((field) => field.label === 'Cue');
|
||||||
const titleIndex = builtInFieldDefs.findIndex((field) => field.label === 'Title');
|
const titleIndex = builtInFieldDefs.findIndex((field) => field.label === 'Title');
|
||||||
|
const idIndex = builtInFieldDefs.findIndex((field) => field.importKey === 'id');
|
||||||
|
|
||||||
describe('getImportWarnings()', () => {
|
describe('getImportWarnings()', () => {
|
||||||
it('warns when two mappings target the same spreadsheet column', () => {
|
it('warns when two mappings target the same spreadsheet column', () => {
|
||||||
@@ -58,7 +64,7 @@ describe('getImportWarnings()', () => {
|
|||||||
expect(warnings['custom.0.importName']).toStrictEqual({ kind: 'invalid-name' });
|
expect(warnings['custom.0.importName']).toStrictEqual({ kind: 'invalid-name' });
|
||||||
});
|
});
|
||||||
|
|
||||||
it('warns when a custom header resolves to an existing Ontime field name', () => {
|
it('warns when a custom header resolves to a built-in or duplicate imported field name', () => {
|
||||||
const values = createDefaultFormValues();
|
const values = createDefaultFormValues();
|
||||||
values.custom = [
|
values.custom = [
|
||||||
{ ontimeName: '', importName: 'Artist-1' },
|
{ ontimeName: '', importName: 'Artist-1' },
|
||||||
@@ -67,12 +73,20 @@ describe('getImportWarnings()', () => {
|
|||||||
{ ontimeName: '', importName: 'Presenter-1' },
|
{ ontimeName: '', importName: 'Presenter-1' },
|
||||||
];
|
];
|
||||||
|
|
||||||
const warnings = getImportWarnings(values, ['Artist-1', 'Artist/1', 'Title!', 'Presenter-1'], ['Presenter 1']);
|
const warnings = getImportWarnings(values, ['Artist-1', 'Artist/1', 'Title!', 'Presenter-1']);
|
||||||
|
|
||||||
expect(warnings['custom.0.importName']).toBeUndefined();
|
expect(warnings['custom.0.importName']).toBeUndefined();
|
||||||
expect(warnings['custom.1.importName']).toStrictEqual({ kind: 'name-collision' });
|
expect(warnings['custom.1.importName']).toStrictEqual({ kind: 'name-collision' });
|
||||||
expect(warnings['custom.2.importName']).toStrictEqual({ kind: 'name-collision' });
|
expect(warnings['custom.2.importName']).toStrictEqual({ kind: 'name-collision' });
|
||||||
expect(warnings['custom.3.importName']).toStrictEqual({ kind: 'name-collision' });
|
expect(warnings['custom.3.importName']).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not give false warnings for pre-existing custom fields', () => {
|
||||||
|
const values = createDefaultFormValues();
|
||||||
|
values.custom = [{ ontimeName: '', importName: 'Video Info' }];
|
||||||
|
|
||||||
|
const warnings = getImportWarnings(values, ['Video Info']);
|
||||||
|
expect(warnings['custom.0.importName']).toBeUndefined();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -120,3 +134,64 @@ describe('convertToImportMap()', () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe('getProvidedImportFields()', () => {
|
||||||
|
it('reports the mapped built-in and custom fields the sheet supplies', () => {
|
||||||
|
const values = createDefaultFormValues();
|
||||||
|
values.builtIn[titleIndex] = { header: 'title', enabled: true };
|
||||||
|
values.builtIn[cueIndex] = { header: '', enabled: false };
|
||||||
|
values.custom = [{ ontimeName: 'ignored', importName: 'FOH/Monitor' }];
|
||||||
|
|
||||||
|
const provided = getProvidedImportFields(convertToImportMap(values));
|
||||||
|
|
||||||
|
// enabled built-in mappings are reported as event fields, disabled ones are not
|
||||||
|
expect(provided.event).toContain('title');
|
||||||
|
expect(provided.event).not.toContain('cue');
|
||||||
|
// the id column is only used for matching, never overwritten
|
||||||
|
expect(provided.event).not.toContain('id');
|
||||||
|
// custom fields are reported symmetrically by their resolved Ontime name
|
||||||
|
expect(provided.custom).toStrictEqual(['FOH Monitor']);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('isIdColumnMapped()', () => {
|
||||||
|
it('is true when the ID field is enabled with a header', () => {
|
||||||
|
// the default form maps the ID column
|
||||||
|
expect(isIdColumnMapped(createDefaultFormValues())).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('is false when the ID field is disabled', () => {
|
||||||
|
const values = createDefaultFormValues();
|
||||||
|
values.builtIn[idIndex] = { header: 'id', enabled: false };
|
||||||
|
expect(isIdColumnMapped(values)).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('is false when the ID field header is blank', () => {
|
||||||
|
const values = createDefaultFormValues();
|
||||||
|
values.builtIn[idIndex] = { header: ' ', enabled: true };
|
||||||
|
expect(isIdColumnMapped(values)).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('import mode persistence', () => {
|
||||||
|
const sourceKey = 'excel-test';
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
localStorage.clear();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('defaults to override when nothing is persisted', () => {
|
||||||
|
expect(getPersistedImportMode(sourceKey)).toBe('override');
|
||||||
|
expect(defaultImportMode).toBe('override');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('round-trips a persisted value', () => {
|
||||||
|
persistImportMode(sourceKey, 'merge');
|
||||||
|
expect(getPersistedImportMode(sourceKey)).toBe('merge');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('falls back to the default when the persisted value is invalid', () => {
|
||||||
|
persistImportMode(sourceKey, 'nonsense' as never);
|
||||||
|
expect(getPersistedImportMode(sourceKey)).toBe('override');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|||||||
+64
-15
@@ -1,3 +1,4 @@
|
|||||||
|
import type { ImportedFields, RundownImportMode } from 'ontime-types';
|
||||||
import type { ImportMap } from 'ontime-utils';
|
import type { ImportMap } from 'ontime-utils';
|
||||||
|
|
||||||
import { makeStageKey } from '../../../../../../common/utils/localStorage';
|
import { makeStageKey } from '../../../../../../common/utils/localStorage';
|
||||||
@@ -49,6 +50,16 @@ export function createDefaultFormValues(): ImportFormValues {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the mapping supplies an ID column. Merge matches entries by ID, so without one every
|
||||||
|
* imported entry gets a fresh id and nothing can reconcile with the current rundown.
|
||||||
|
*/
|
||||||
|
export function isIdColumnMapped(values: ImportFormValues): boolean {
|
||||||
|
const idIndex = builtInFieldDefs.findIndex((def) => def.importKey === 'id');
|
||||||
|
const field = values.builtIn[idIndex];
|
||||||
|
return Boolean(field?.enabled && field.header.trim());
|
||||||
|
}
|
||||||
|
|
||||||
function sanitiseOntimeCustomFieldLabel(importName: string): string {
|
function sanitiseOntimeCustomFieldLabel(importName: string): string {
|
||||||
// Replace punctuation with spaces, then collapse repeated whitespace into single spaces.
|
// Replace punctuation with spaces, then collapse repeated whitespace into single spaces.
|
||||||
const sanitised = importName
|
const sanitised = importName
|
||||||
@@ -81,6 +92,24 @@ export function getResolvedCustomFields(customFields: ImportFormValues['custom']
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the fields the import map supplies — the complete description of what the incoming data
|
||||||
|
* provides, for both built-in and custom fields. A merge uses this to patch exactly these fields
|
||||||
|
* onto a matched event and keep everything else (e.g. automations) untouched.
|
||||||
|
* Import-map keys are OntimeEvent field names; `worksheet`/`custom` are meta and `id` is only used
|
||||||
|
* for matching, not overwritten.
|
||||||
|
*/
|
||||||
|
export function getProvidedImportFields(importMap: ImportMap): ImportedFields {
|
||||||
|
const event: string[] = [];
|
||||||
|
for (const [key, value] of Object.entries(importMap)) {
|
||||||
|
if (key === 'worksheet' || key === 'custom' || key === 'id') continue;
|
||||||
|
if (typeof value === 'string' && value.trim() !== '') {
|
||||||
|
event.push(key);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return { event, custom: Object.keys(importMap.custom) };
|
||||||
|
}
|
||||||
|
|
||||||
export function convertToImportMap(values: ImportFormValues): ImportMap {
|
export function convertToImportMap(values: ImportFormValues): ImportMap {
|
||||||
const custom = getResolvedCustomFields(values.custom).reduce<Record<string, string>>(
|
const custom = getResolvedCustomFields(values.custom).reduce<Record<string, string>>(
|
||||||
(accumulator, { ontimeName, importName }) => {
|
(accumulator, { ontimeName, importName }) => {
|
||||||
@@ -127,40 +156,64 @@ function isPersistedFormValues(obj: unknown): obj is ImportFormValues {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
export function getPersistedImportState(sourceKey: string): ImportFormValues {
|
export function getPersistedImportState(sourceKey: string): { values: ImportFormValues; isPersisted: boolean } {
|
||||||
const storageKey = getImportMapKey(sourceKey);
|
const storageKey = getImportMapKey(sourceKey);
|
||||||
try {
|
try {
|
||||||
const raw = localStorage.getItem(storageKey);
|
const persistedData = localStorage.getItem(storageKey);
|
||||||
if (!raw) {
|
if (!persistedData) {
|
||||||
return createDefaultFormValues();
|
return { values: createDefaultFormValues(), isPersisted: false };
|
||||||
}
|
}
|
||||||
|
|
||||||
const parsed: unknown = JSON.parse(raw);
|
const parsed: unknown = JSON.parse(persistedData);
|
||||||
if (isPersistedFormValues(parsed)) {
|
if (isPersistedFormValues(parsed)) {
|
||||||
return parsed;
|
return { values: parsed, isPersisted: true };
|
||||||
}
|
}
|
||||||
|
|
||||||
// Invalid schema - delete malformed data
|
// Invalid schema - delete malformed data
|
||||||
localStorage.removeItem(storageKey);
|
localStorage.removeItem(storageKey);
|
||||||
return createDefaultFormValues();
|
return { values: createDefaultFormValues(), isPersisted: false };
|
||||||
} catch {
|
} catch {
|
||||||
// Parse error - delete corrupted data
|
// Parse error - delete corrupted data
|
||||||
localStorage.removeItem(storageKey);
|
localStorage.removeItem(storageKey);
|
||||||
return createDefaultFormValues();
|
return { values: createDefaultFormValues(), isPersisted: false };
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The import mode (new / merge / override) is persisted separately from the field mapping
|
||||||
|
* so the mapping schema guard stays untouched.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** Default import mode: replace matched elements in the current rundown */
|
||||||
|
export const defaultImportMode: RundownImportMode = 'override';
|
||||||
|
|
||||||
|
function getImportModeKey(sourceKey: string) {
|
||||||
|
return makeStageKey(`import-mode:${sourceKey}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Persists the import mode for a given source */
|
||||||
|
export function persistImportMode(sourceKey: string, mode: RundownImportMode) {
|
||||||
|
localStorage.setItem(getImportModeKey(sourceKey), mode);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Reads the persisted import mode for a source, falling back to the default when absent or invalid */
|
||||||
|
export function getPersistedImportMode(sourceKey: string): RundownImportMode {
|
||||||
|
const persisted = localStorage.getItem(getImportModeKey(sourceKey));
|
||||||
|
if (persisted === 'new' || persisted === 'merge' || persisted === 'override') {
|
||||||
|
return persisted;
|
||||||
|
}
|
||||||
|
return defaultImportMode;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Validates import mappings and generates warnings for duplicate or missing spreadsheet columns.
|
* Validates import mappings and generates warnings for duplicate or missing spreadsheet columns.
|
||||||
*/
|
*/
|
||||||
export function getImportWarnings(
|
export function getImportWarnings(
|
||||||
values: ImportFormValues,
|
values: ImportFormValues,
|
||||||
detectedSpreadsheetColumns: string[],
|
detectedSpreadsheetColumns: string[],
|
||||||
existingCustomFieldLabels: string[] = [],
|
|
||||||
): Record<string, MappingWarning | undefined> {
|
): Record<string, MappingWarning | undefined> {
|
||||||
const normalisedHeaders = new Set(detectedSpreadsheetColumns.map(normaliseColumnName).filter(Boolean));
|
const normalisedHeaders = new Set(detectedSpreadsheetColumns.map(normaliseColumnName).filter(Boolean));
|
||||||
const builtInLabels = new Set(builtInFieldDefs.map((def) => def.label.toLowerCase()));
|
const builtInLabels = new Set(builtInFieldDefs.map((def) => def.label.toLowerCase()));
|
||||||
const existingLabels = new Set(existingCustomFieldLabels.map((label) => label.trim().toLowerCase()).filter(Boolean));
|
|
||||||
const seenColumns = new Set<string>();
|
const seenColumns = new Set<string>();
|
||||||
const seenDerivedLabels = new Set<string>();
|
const seenDerivedLabels = new Set<string>();
|
||||||
const warnings: Record<string, MappingWarning | undefined> = {};
|
const warnings: Record<string, MappingWarning | undefined> = {};
|
||||||
@@ -200,11 +253,7 @@ export function getImportWarnings(
|
|||||||
warnings[key] = { kind: 'missing' };
|
warnings[key] = { kind: 'missing' };
|
||||||
} else {
|
} else {
|
||||||
const normalisedDerivedLabel = sanitisedLabel.toLowerCase();
|
const normalisedDerivedLabel = sanitisedLabel.toLowerCase();
|
||||||
if (
|
if (builtInLabels.has(normalisedDerivedLabel) || seenDerivedLabels.has(normalisedDerivedLabel)) {
|
||||||
builtInLabels.has(normalisedDerivedLabel) ||
|
|
||||||
existingLabels.has(normalisedDerivedLabel) ||
|
|
||||||
seenDerivedLabels.has(normalisedDerivedLabel)
|
|
||||||
) {
|
|
||||||
warnings[key] = { kind: 'name-collision' };
|
warnings[key] = { kind: 'name-collision' };
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+102
-24
@@ -1,27 +1,35 @@
|
|||||||
.emptyState {
|
.emptyState {
|
||||||
height: 100%;
|
padding: 3rem 1.5rem;
|
||||||
min-height: 16rem;
|
|
||||||
display: grid;
|
|
||||||
place-content: center;
|
|
||||||
gap: 0.35rem;
|
|
||||||
padding: 1.5rem;
|
|
||||||
text-align: center;
|
text-align: center;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.emptyMessage {
|
||||||
|
width: min(30rem, 100%);
|
||||||
|
margin-inline: auto;
|
||||||
|
}
|
||||||
|
|
||||||
.emptyTitle {
|
.emptyTitle {
|
||||||
color: $ui-white;
|
margin-bottom: 0.25rem;
|
||||||
font-size: 1rem;
|
color: rgba($gray-200, 0.72);
|
||||||
font-weight: 600;
|
font-size: calc(1rem + 2px);
|
||||||
|
font-weight: 400;
|
||||||
}
|
}
|
||||||
|
|
||||||
.emptyBody {
|
.emptyBody {
|
||||||
color: $gray-400;
|
color: rgba($gray-200, 0.55);
|
||||||
font-size: 0.95rem;
|
font-size: calc(1rem - 3px);
|
||||||
|
line-height: 1.5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.emptyAction {
|
||||||
|
margin: 1rem auto 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
.table {
|
.table {
|
||||||
width: 100%;
|
width: 100%;
|
||||||
border-collapse: collapse;
|
border-collapse: separate;
|
||||||
|
border-spacing: 0;
|
||||||
|
color: $ui-white;
|
||||||
font-size: calc(1rem - 2px);
|
font-size: calc(1rem - 2px);
|
||||||
text-align: left;
|
text-align: left;
|
||||||
table-layout: auto;
|
table-layout: auto;
|
||||||
@@ -34,31 +42,101 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
th {
|
th {
|
||||||
font-weight: 400;
|
color: $gray-300;
|
||||||
color: $gray-400;
|
font-size: 0.8rem;
|
||||||
text-transform: capitalize;
|
font-weight: 600;
|
||||||
vertical-align: top;
|
letter-spacing: 0.02em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
vertical-align: bottom;
|
||||||
white-space: normal;
|
white-space: normal;
|
||||||
}
|
}
|
||||||
|
|
||||||
th,
|
th,
|
||||||
td {
|
td {
|
||||||
padding: 0.5rem;
|
box-sizing: border-box;
|
||||||
min-width: 8rem;
|
min-width: 8rem;
|
||||||
vertical-align: top;
|
max-width: 20rem;
|
||||||
|
padding: 0.55rem 0.65rem;
|
||||||
|
border-bottom: 1px solid $white-10;
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
vertical-align: middle;
|
||||||
|
white-space: nowrap;
|
||||||
}
|
}
|
||||||
|
|
||||||
tr:nth-child(even) {
|
tbody tr {
|
||||||
background-color: $white-1;
|
--entry-colour: transparent;
|
||||||
|
background-color: color-mix(in srgb, $gray-1300 96%, var(--entry-colour) 4%);
|
||||||
|
box-shadow: inset 3px 0 var(--entry-colour);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
td[data-empty='true'] {
|
||||||
|
color: $gray-600;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.rowNumber,
|
||||||
|
.rowType {
|
||||||
|
position: sticky;
|
||||||
|
z-index: 1;
|
||||||
|
background-color: inherit;
|
||||||
}
|
}
|
||||||
|
|
||||||
.rowNumber {
|
.rowNumber {
|
||||||
width: 4.5rem;
|
left: 0;
|
||||||
min-width: 4.5rem;
|
width: 3.25rem;
|
||||||
|
min-width: 3.25rem !important;
|
||||||
|
color: $gray-400;
|
||||||
|
text-align: right;
|
||||||
}
|
}
|
||||||
|
|
||||||
.rowType {
|
.rowType {
|
||||||
width: 7rem;
|
left: 3.25rem;
|
||||||
min-width: 7rem;
|
width: 6.25rem;
|
||||||
|
min-width: 6.25rem !important;
|
||||||
|
color: $gray-400;
|
||||||
|
font-size: 0.8rem;
|
||||||
|
box-shadow: 1px 0 $white-10;
|
||||||
|
}
|
||||||
|
|
||||||
|
thead .rowNumber,
|
||||||
|
thead .rowType {
|
||||||
|
z-index: 2;
|
||||||
|
background-color: $gray-1350;
|
||||||
|
}
|
||||||
|
|
||||||
|
.numericCell {
|
||||||
|
font-variant-numeric: tabular-nums;
|
||||||
|
text-align: right;
|
||||||
|
}
|
||||||
|
|
||||||
|
.multilineCell {
|
||||||
|
max-width: 30rem !important;
|
||||||
|
overflow-wrap: anywhere;
|
||||||
|
text-overflow: clip !important;
|
||||||
|
white-space: pre-wrap !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.eventRow {
|
||||||
|
.rowNumber {
|
||||||
|
font-variant-numeric: tabular-nums;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.groupRow {
|
||||||
|
background-color: color-mix(in srgb, $gray-1300 88%, var(--entry-colour) 12%) !important;
|
||||||
|
box-shadow: inset 4px 0 var(--entry-colour) !important;
|
||||||
|
font-weight: 600;
|
||||||
|
|
||||||
|
td {
|
||||||
|
min-height: 3.25rem;
|
||||||
|
border-top: 0.75rem solid $gray-1350;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.milestoneRow {
|
||||||
|
background-color: color-mix(in srgb, $gray-1300 93%, var(--entry-colour) 7%) !important;
|
||||||
|
box-shadow: inset 3px 0 var(--entry-colour) !important;
|
||||||
|
color: $gray-300;
|
||||||
|
font-style: italic;
|
||||||
}
|
}
|
||||||
|
|||||||
+126
-14
@@ -1,7 +1,11 @@
|
|||||||
import type { CustomField, CustomFieldKey, SpreadsheetPreviewResponse } from 'ontime-types';
|
import type { CustomField, CustomFieldKey, SpreadsheetPreviewResponse } from 'ontime-types';
|
||||||
import { isOntimeEvent, isOntimeGroup, isOntimeMilestone } from 'ontime-types';
|
import { isOntimeDelay, isOntimeEvent, isOntimeGroup, isOntimeMilestone } from 'ontime-types';
|
||||||
|
import type { CSSProperties } from 'react';
|
||||||
import { useMemo } from 'react';
|
import { useMemo } from 'react';
|
||||||
|
|
||||||
|
import Button from '../../../../../../../common/components/buttons/Button';
|
||||||
|
import Tag from '../../../../../../../common/components/tag/Tag';
|
||||||
|
import { getRundownMetadata } from '../../../../../../../common/utils/rundownMetadata';
|
||||||
import { getCellValue } from './previewTableUtils';
|
import { getCellValue } from './previewTableUtils';
|
||||||
|
|
||||||
import style from './PreviewTable.module.scss';
|
import style from './PreviewTable.module.scss';
|
||||||
@@ -9,14 +13,85 @@ import style from './PreviewTable.module.scss';
|
|||||||
interface PreviewTableProps {
|
interface PreviewTableProps {
|
||||||
preview: SpreadsheetPreviewResponse | null;
|
preview: SpreadsheetPreviewResponse | null;
|
||||||
columnLabels: string[];
|
columnLabels: string[];
|
||||||
|
canRefresh: boolean;
|
||||||
isLoadingMetadata: boolean;
|
isLoadingMetadata: boolean;
|
||||||
|
isRefreshing: boolean;
|
||||||
|
needsPreviewRefresh: boolean;
|
||||||
|
onRefresh: () => void;
|
||||||
worksheetHeaders: string[];
|
worksheetHeaders: string[];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const priorityColumns = ['Title', 'Cue', 'Start', 'End', 'Duration'];
|
||||||
|
const numericColumns = new Set(['Start', 'End', 'Duration', 'Time warning', 'Time danger']);
|
||||||
|
const transparentColour = 'transparent';
|
||||||
|
|
||||||
|
type PreviewEntry = SpreadsheetPreviewResponse['rundown']['entries'][string];
|
||||||
|
|
||||||
|
function getEntryDisplay(entry: PreviewEntry, groupColour?: string) {
|
||||||
|
if (isOntimeGroup(entry)) {
|
||||||
|
return {
|
||||||
|
rowClassName: style.groupRow,
|
||||||
|
entryColour: entry.colour,
|
||||||
|
entryType: 'Group',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const entryColour = groupColour ?? transparentColour;
|
||||||
|
|
||||||
|
if (isOntimeMilestone(entry)) {
|
||||||
|
return {
|
||||||
|
rowClassName: style.milestoneRow,
|
||||||
|
entryColour,
|
||||||
|
entryType: 'Milestone',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isOntimeDelay(entry)) {
|
||||||
|
return {
|
||||||
|
rowClassName: style.eventRow,
|
||||||
|
entryColour,
|
||||||
|
entryType: 'Delay',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
rowClassName: style.eventRow,
|
||||||
|
entryColour,
|
||||||
|
entryType: 'Event',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function getCellClassName(label: string, value: string) {
|
||||||
|
if (value.includes('\n')) {
|
||||||
|
return style.multilineCell;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (numericColumns.has(label)) {
|
||||||
|
return style.numericCell;
|
||||||
|
}
|
||||||
|
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
function getDisplayColumns(columnLabels: string[]) {
|
||||||
|
return [...columnLabels].sort((left, right) => {
|
||||||
|
const leftPriority = priorityColumns.indexOf(left);
|
||||||
|
const rightPriority = priorityColumns.indexOf(right);
|
||||||
|
return (
|
||||||
|
(leftPriority === -1 ? priorityColumns.length : leftPriority) -
|
||||||
|
(rightPriority === -1 ? priorityColumns.length : rightPriority)
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
export default function PreviewTable({
|
export default function PreviewTable({
|
||||||
preview,
|
preview,
|
||||||
columnLabels,
|
columnLabels,
|
||||||
|
canRefresh,
|
||||||
isLoadingMetadata,
|
isLoadingMetadata,
|
||||||
|
isRefreshing,
|
||||||
|
needsPreviewRefresh,
|
||||||
|
onRefresh,
|
||||||
worksheetHeaders,
|
worksheetHeaders,
|
||||||
}: PreviewTableProps) {
|
}: PreviewTableProps) {
|
||||||
const customFieldKeyByLabel = useMemo(() => {
|
const customFieldKeyByLabel = useMemo(() => {
|
||||||
@@ -24,33 +99,57 @@ export default function PreviewTable({
|
|||||||
return new Map(Object.entries(preview.customFields).map(([fieldId, field]) => [field.label, fieldId]));
|
return new Map(Object.entries(preview.customFields).map(([fieldId, field]) => [field.label, fieldId]));
|
||||||
}, [preview]);
|
}, [preview]);
|
||||||
|
|
||||||
|
const displayColumns = useMemo(() => getDisplayColumns(columnLabels), [columnLabels]);
|
||||||
|
|
||||||
|
const previewMetadata = useMemo(() => {
|
||||||
|
if (!preview) return null;
|
||||||
|
return getRundownMetadata(preview.rundown, null);
|
||||||
|
}, [preview]);
|
||||||
|
|
||||||
if (!preview) {
|
if (!preview) {
|
||||||
|
let emptyTitle = 'Preview not generated';
|
||||||
let emptyContent = 'Select the fields you want to import, then click Preview import.';
|
let emptyContent = 'Select the fields you want to import, then click Preview import.';
|
||||||
|
|
||||||
if (isLoadingMetadata) {
|
if (isLoadingMetadata) {
|
||||||
|
emptyTitle = 'Loading worksheet';
|
||||||
emptyContent = 'Loading worksheet metadata...';
|
emptyContent = 'Loading worksheet metadata...';
|
||||||
} else if (worksheetHeaders.length === 0) {
|
} else if (worksheetHeaders.length === 0) {
|
||||||
|
emptyTitle = 'No headers found';
|
||||||
emptyContent =
|
emptyContent =
|
||||||
'No column headers detected in this worksheet. Try a different worksheet or ensure the first row contains column headers.';
|
'No column headers detected in this worksheet. Try a different worksheet or ensure the first row contains column headers.';
|
||||||
|
} else if (needsPreviewRefresh) {
|
||||||
|
emptyTitle = 'Preview needs updating';
|
||||||
|
emptyContent = 'Your column mapping changed. Preview the import again to update this table.';
|
||||||
}
|
}
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className={style.emptyState}>
|
<div className={style.emptyState}>
|
||||||
<div className={style.emptyTitle}>Preview not generated</div>
|
<div className={style.emptyMessage}>
|
||||||
<div className={style.emptyBody}>{emptyContent}</div>
|
<div className={style.emptyTitle}>{emptyTitle}</div>
|
||||||
|
<div className={style.emptyBody}>{emptyContent}</div>
|
||||||
|
{needsPreviewRefresh && (
|
||||||
|
<Button
|
||||||
|
className={style.emptyAction}
|
||||||
|
variant='primary'
|
||||||
|
onClick={onRefresh}
|
||||||
|
disabled={!canRefresh}
|
||||||
|
loading={isRefreshing}
|
||||||
|
>
|
||||||
|
Refresh preview
|
||||||
|
</Button>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
let eventIndex = 0;
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<table className={style.table}>
|
<table className={style.table}>
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th className={style.rowNumber}>#</th>
|
<th className={style.rowNumber}>#</th>
|
||||||
<th className={style.rowType}>Type</th>
|
<th className={style.rowType}>Type</th>
|
||||||
{columnLabels.map((label, index) => (
|
{displayColumns.map((label, index) => (
|
||||||
<th key={`${label}-${index}`}>{label}</th>
|
<th key={`${label}-${index}`}>{label}</th>
|
||||||
))}
|
))}
|
||||||
</tr>
|
</tr>
|
||||||
@@ -59,16 +158,29 @@ export default function PreviewTable({
|
|||||||
{preview.rundown.flatOrder.map((entryId) => {
|
{preview.rundown.flatOrder.map((entryId) => {
|
||||||
const entry = preview.rundown.entries[entryId];
|
const entry = preview.rundown.entries[entryId];
|
||||||
const isEvent = isOntimeEvent(entry);
|
const isEvent = isOntimeEvent(entry);
|
||||||
if (isEvent) eventIndex++;
|
const entryMetadata = previewMetadata?.[entryId];
|
||||||
const hasType = isEvent || isOntimeGroup(entry) || isOntimeMilestone(entry);
|
const { rowClassName, entryColour, entryType } = getEntryDisplay(entry, entryMetadata?.groupColour);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<tr key={entryId}>
|
<tr key={entryId} className={rowClassName} style={{ '--entry-colour': entryColour } as CSSProperties}>
|
||||||
<td className={style.rowNumber}>{isEvent ? eventIndex : ''}</td>
|
<td className={style.rowNumber}>{isEvent ? entryMetadata?.eventIndex : ''}</td>
|
||||||
<td className={style.rowType}>{hasType ? entry.type : ''}</td>
|
<td className={style.rowType}>
|
||||||
{columnLabels.map((label, colIndex) => (
|
<Tag>{entryType}</Tag>
|
||||||
<td key={`${entryId}-${colIndex}`}>{getCellValue(label, entry, customFieldKeyByLabel)}</td>
|
</td>
|
||||||
))}
|
{displayColumns.map((label, colIndex) => {
|
||||||
|
const value = getCellValue(label, entry, customFieldKeyByLabel);
|
||||||
|
const cellClassName = getCellClassName(label, value);
|
||||||
|
return (
|
||||||
|
<td
|
||||||
|
key={`${entryId}-${colIndex}`}
|
||||||
|
className={cellClassName}
|
||||||
|
data-empty={value === ''}
|
||||||
|
title={value || undefined}
|
||||||
|
>
|
||||||
|
{value}
|
||||||
|
</td>
|
||||||
|
);
|
||||||
|
})}
|
||||||
</tr>
|
</tr>
|
||||||
);
|
);
|
||||||
})}
|
})}
|
||||||
|
|||||||
+92
-27
@@ -1,19 +1,27 @@
|
|||||||
import { useQuery, useQueryClient } from '@tanstack/react-query';
|
import { useQuery, useQueryClient } from '@tanstack/react-query';
|
||||||
import type { SpreadsheetPreviewResponse, SpreadsheetWorksheetMetadata } from 'ontime-types';
|
import type {
|
||||||
import { millisToString } from 'ontime-utils';
|
ImportedFields,
|
||||||
import { useCallback, useEffect, useMemo, useReducer, useRef } from 'react';
|
RundownImportMode,
|
||||||
|
SpreadsheetPreviewResponse,
|
||||||
|
SpreadsheetWorksheetMetadata,
|
||||||
|
} from 'ontime-types';
|
||||||
|
import { isOntimeGroup, isOntimeMilestone } from 'ontime-types';
|
||||||
|
import { millisToString, removeTrailingZero } from 'ontime-utils';
|
||||||
|
import { useCallback, useEffect, useMemo, useReducer, useRef, useState } from 'react';
|
||||||
import { useFieldArray, useForm } from 'react-hook-form';
|
import { useFieldArray, useForm } from 'react-hook-form';
|
||||||
|
|
||||||
import { maybeAxiosError } from '../../../../../../common/api/utils';
|
import { maybeAxiosError } from '../../../../../../common/api/utils';
|
||||||
import useCustomFields from '../../../../../../common/hooks-query/useCustomFields';
|
|
||||||
import { formatDuration } from '../../../../../../common/utils/time';
|
import { formatDuration } from '../../../../../../common/utils/time';
|
||||||
import {
|
import {
|
||||||
type ImportFormValues,
|
type ImportFormValues,
|
||||||
builtInFieldDefs,
|
builtInFieldDefs,
|
||||||
convertToImportMap,
|
convertToImportMap,
|
||||||
getImportWarnings,
|
getImportWarnings,
|
||||||
|
getPersistedImportMode,
|
||||||
getPersistedImportState,
|
getPersistedImportState,
|
||||||
|
getProvidedImportFields,
|
||||||
getResolvedCustomFields,
|
getResolvedCustomFields,
|
||||||
|
persistImportMode,
|
||||||
persistImportState,
|
persistImportState,
|
||||||
} from './importMapUtils';
|
} from './importMapUtils';
|
||||||
import { deriveHeaderOptionsState } from './spreadsheetImportUtils';
|
import { deriveHeaderOptionsState } from './spreadsheetImportUtils';
|
||||||
@@ -25,7 +33,7 @@ type ImportAction =
|
|||||||
| { type: 'previewSuccess'; preview: SpreadsheetPreviewResponse }
|
| { type: 'previewSuccess'; preview: SpreadsheetPreviewResponse }
|
||||||
| { type: 'applySuccess' }
|
| { type: 'applySuccess' }
|
||||||
| { type: 'exportSuccess' }
|
| { type: 'exportSuccess' }
|
||||||
| { type: 'clearPreview'; error?: string }
|
| { type: 'clearPreview'; error?: string; needsRefresh?: boolean }
|
||||||
| { type: 'failure'; error: string }
|
| { type: 'failure'; error: string }
|
||||||
| { type: 'reset' };
|
| { type: 'reset' };
|
||||||
|
|
||||||
@@ -33,12 +41,14 @@ type ImportState = {
|
|||||||
loading: '' | 'preview' | 'apply' | 'export';
|
loading: '' | 'preview' | 'apply' | 'export';
|
||||||
error: string;
|
error: string;
|
||||||
preview: SpreadsheetPreviewResponse | null;
|
preview: SpreadsheetPreviewResponse | null;
|
||||||
|
needsPreviewRefresh: boolean;
|
||||||
};
|
};
|
||||||
|
|
||||||
const initialImportState: ImportState = {
|
const initialImportState: ImportState = {
|
||||||
loading: '',
|
loading: '',
|
||||||
error: '',
|
error: '',
|
||||||
preview: null,
|
preview: null,
|
||||||
|
needsPreviewRefresh: false,
|
||||||
};
|
};
|
||||||
|
|
||||||
function importReducer(state: ImportState, action: ImportAction): ImportState {
|
function importReducer(state: ImportState, action: ImportAction): ImportState {
|
||||||
@@ -50,15 +60,15 @@ function importReducer(state: ImportState, action: ImportAction): ImportState {
|
|||||||
case 'startExport':
|
case 'startExport':
|
||||||
return { ...state, loading: 'export', error: '' };
|
return { ...state, loading: 'export', error: '' };
|
||||||
case 'previewSuccess':
|
case 'previewSuccess':
|
||||||
return { loading: '', error: '', preview: action.preview };
|
return { loading: '', error: '', preview: action.preview, needsPreviewRefresh: false };
|
||||||
case 'applySuccess':
|
case 'applySuccess':
|
||||||
case 'exportSuccess':
|
case 'exportSuccess':
|
||||||
return { ...state, loading: '' };
|
return { ...state, loading: '' };
|
||||||
case 'clearPreview':
|
case 'clearPreview':
|
||||||
return { ...state, error: action.error ?? '', preview: null };
|
return { ...state, error: action.error ?? '', preview: null, needsPreviewRefresh: action.needsRefresh ?? false };
|
||||||
case 'failure': {
|
case 'failure': {
|
||||||
if (state.loading === 'preview') {
|
if (state.loading === 'preview') {
|
||||||
return { loading: '', error: action.error, preview: null };
|
return { loading: '', error: action.error, preview: null, needsPreviewRefresh: false };
|
||||||
}
|
}
|
||||||
return { ...state, loading: '', error: action.error };
|
return { ...state, loading: '', error: action.error };
|
||||||
}
|
}
|
||||||
@@ -101,16 +111,23 @@ function buildColumnLabels(values: ImportFormValues): string[] {
|
|||||||
|
|
||||||
interface UseSheetImportFormProps {
|
interface UseSheetImportFormProps {
|
||||||
sourceKey: string;
|
sourceKey: string;
|
||||||
|
defaultRundownName: string;
|
||||||
worksheetNames: string[];
|
worksheetNames: string[];
|
||||||
initialMetadata: SpreadsheetWorksheetMetadata | null;
|
initialMetadata: SpreadsheetWorksheetMetadata | null;
|
||||||
loadMetadata: (worksheet: string) => Promise<SpreadsheetWorksheetMetadata>;
|
loadMetadata: (worksheet: string) => Promise<SpreadsheetWorksheetMetadata>;
|
||||||
previewImport: (importMap: ReturnType<typeof convertToImportMap>) => Promise<SpreadsheetPreviewResponse>;
|
previewImport: (importMap: ReturnType<typeof convertToImportMap>) => Promise<SpreadsheetPreviewResponse>;
|
||||||
onApply: (preview: SpreadsheetPreviewResponse) => Promise<void>;
|
onApply: (
|
||||||
|
preview: SpreadsheetPreviewResponse,
|
||||||
|
mode: RundownImportMode,
|
||||||
|
newRundownTitle: string,
|
||||||
|
providedFields: ImportedFields,
|
||||||
|
) => Promise<void>;
|
||||||
onExport?: (importMap: ReturnType<typeof convertToImportMap>) => Promise<void>;
|
onExport?: (importMap: ReturnType<typeof convertToImportMap>) => Promise<void>;
|
||||||
}
|
}
|
||||||
|
|
||||||
export function useSheetImportForm({
|
export function useSheetImportForm({
|
||||||
sourceKey,
|
sourceKey,
|
||||||
|
defaultRundownName,
|
||||||
worksheetNames,
|
worksheetNames,
|
||||||
initialMetadata,
|
initialMetadata,
|
||||||
loadMetadata,
|
loadMetadata,
|
||||||
@@ -118,10 +135,15 @@ export function useSheetImportForm({
|
|||||||
onApply,
|
onApply,
|
||||||
onExport,
|
onExport,
|
||||||
}: UseSheetImportFormProps) {
|
}: UseSheetImportFormProps) {
|
||||||
const initialFormValues = useMemo(() => {
|
const { initialFormValues, skipAutoPreview } = useMemo(() => {
|
||||||
const persisted = getPersistedImportState(sourceKey);
|
const { values, isPersisted } = getPersistedImportState(sourceKey);
|
||||||
const worksheet = getPreferredWorksheet(worksheetNames, persisted.worksheet, initialMetadata?.worksheet ?? '');
|
const worksheet = getPreferredWorksheet(worksheetNames, values.worksheet, initialMetadata?.worksheet ?? '');
|
||||||
return { ...persisted, worksheet };
|
// Skip auto-preview when restoring a persisted mapping that was saved for a different worksheet.
|
||||||
|
const hasWorksheetChanged = values.worksheet !== worksheet;
|
||||||
|
return {
|
||||||
|
initialFormValues: { ...values, worksheet },
|
||||||
|
skipAutoPreview: isPersisted && hasWorksheetChanged,
|
||||||
|
};
|
||||||
}, [initialMetadata?.worksheet, sourceKey, worksheetNames]);
|
}, [initialMetadata?.worksheet, sourceKey, worksheetNames]);
|
||||||
|
|
||||||
const {
|
const {
|
||||||
@@ -139,7 +161,6 @@ export function useSheetImportForm({
|
|||||||
|
|
||||||
const { fields, append, remove } = useFieldArray({ control, name: 'custom' });
|
const { fields, append, remove } = useFieldArray({ control, name: 'custom' });
|
||||||
const values = watch();
|
const values = watch();
|
||||||
const { data: existingCustomFields } = useCustomFields();
|
|
||||||
|
|
||||||
// --- Worksheet metadata via react-query ---
|
// --- Worksheet metadata via react-query ---
|
||||||
const queryClient = useQueryClient();
|
const queryClient = useQueryClient();
|
||||||
@@ -167,20 +188,26 @@ export function useSheetImportForm({
|
|||||||
const columnLabels = buildColumnLabels(values);
|
const columnLabels = buildColumnLabels(values);
|
||||||
|
|
||||||
const [state, dispatch] = useReducer(importReducer, initialImportState);
|
const [state, dispatch] = useReducer(importReducer, initialImportState);
|
||||||
const existingCustomFieldLabels = useMemo(
|
const [importMode, setImportMode] = useState<RundownImportMode>(() => getPersistedImportMode(sourceKey));
|
||||||
() => Object.values(existingCustomFields).map((field) => field.label),
|
const [newRundownTitle, setNewRundownTitle] = useState(defaultRundownName);
|
||||||
[existingCustomFields],
|
const warnings = getImportWarnings(values, headers);
|
||||||
);
|
|
||||||
const warnings = getImportWarnings(values, headers, existingCustomFieldLabels);
|
|
||||||
const warningCount = Object.values(warnings).filter(Boolean).length;
|
const warningCount = Object.values(warnings).filter(Boolean).length;
|
||||||
const previewRef = useRef<SpreadsheetPreviewResponse | null>(null);
|
const previewRef = useRef<SpreadsheetPreviewResponse | null>(null);
|
||||||
|
const autoPreviewFiredRef = useRef(false);
|
||||||
|
|
||||||
// Rehydrate the form from persisted/default state whenever the source context changes.
|
// Rehydrate the form from persisted/default state whenever the source context changes.
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
|
autoPreviewFiredRef.current = false;
|
||||||
reset(initialFormValues);
|
reset(initialFormValues);
|
||||||
dispatch({ type: 'reset' });
|
dispatch({ type: 'reset' });
|
||||||
}, [initialFormValues, reset]);
|
}, [initialFormValues, reset]);
|
||||||
|
|
||||||
|
// Update import mode and rundown name if the source changes
|
||||||
|
useEffect(() => {
|
||||||
|
setImportMode(getPersistedImportMode(sourceKey));
|
||||||
|
setNewRundownTitle(defaultRundownName);
|
||||||
|
}, [sourceKey, defaultRundownName]);
|
||||||
|
|
||||||
// Keep the worksheet selection valid if the available worksheets change underneath the form.
|
// Keep the worksheet selection valid if the available worksheets change underneath the form.
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
if (worksheetNames.length === 0) return;
|
if (worksheetNames.length === 0) return;
|
||||||
@@ -197,7 +224,7 @@ export function useSheetImportForm({
|
|||||||
const sub = watch(() => {
|
const sub = watch(() => {
|
||||||
if (!previewRef.current) return;
|
if (!previewRef.current) return;
|
||||||
previewRef.current = null;
|
previewRef.current = null;
|
||||||
dispatch({ type: 'clearPreview' });
|
dispatch({ type: 'clearPreview', needsRefresh: true });
|
||||||
});
|
});
|
||||||
return () => sub.unsubscribe();
|
return () => sub.unsubscribe();
|
||||||
}, [watch]);
|
}, [watch]);
|
||||||
@@ -225,18 +252,30 @@ export function useSheetImportForm({
|
|||||||
[previewImport],
|
[previewImport],
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// Auto-preview on mount once metadata is ready.
|
||||||
|
useEffect(() => {
|
||||||
|
if (autoPreviewFiredRef.current) return;
|
||||||
|
if (skipAutoPreview) return;
|
||||||
|
if (!isValid || headers.length === 0) return;
|
||||||
|
|
||||||
|
autoPreviewFiredRef.current = true;
|
||||||
|
handleSubmit(handlePreview)();
|
||||||
|
}, [skipAutoPreview, isValid, headers, handleSubmit, handlePreview]);
|
||||||
|
|
||||||
const handleApply = useCallback(async () => {
|
const handleApply = useCallback(async () => {
|
||||||
if (!state.preview) return;
|
if (!state.preview) return;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
dispatch({ type: 'startApply' });
|
dispatch({ type: 'startApply' });
|
||||||
await onApply(state.preview);
|
const providedFields = getProvidedImportFields(convertToImportMap(getValues()));
|
||||||
|
await onApply(state.preview, importMode, newRundownTitle, providedFields);
|
||||||
persistImportState(sourceKey, getValues());
|
persistImportState(sourceKey, getValues());
|
||||||
|
persistImportMode(sourceKey, importMode);
|
||||||
dispatch({ type: 'applySuccess' });
|
dispatch({ type: 'applySuccess' });
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
dispatch({ type: 'failure', error: maybeAxiosError(error) });
|
dispatch({ type: 'failure', error: maybeAxiosError(error) });
|
||||||
}
|
}
|
||||||
}, [getValues, onApply, sourceKey, state.preview]);
|
}, [getValues, importMode, newRundownTitle, onApply, sourceKey, state.preview]);
|
||||||
|
|
||||||
const handleExport = useCallback(
|
const handleExport = useCallback(
|
||||||
async (formValues: ImportFormValues) => {
|
async (formValues: ImportFormValues) => {
|
||||||
@@ -261,15 +300,37 @@ export function useSheetImportForm({
|
|||||||
}, [append]);
|
}, [append]);
|
||||||
|
|
||||||
const toolbarStatus = (() => {
|
const toolbarStatus = (() => {
|
||||||
const warningText = warningCount > 0 ? ` | warnings: ${warningCount}` : '';
|
|
||||||
|
|
||||||
if (!state.preview) {
|
if (!state.preview) {
|
||||||
return `entries: – | start: – | end: – | duration: –${warningText}`;
|
return {
|
||||||
|
entries: '–',
|
||||||
|
groups: '–',
|
||||||
|
milestones: '–',
|
||||||
|
start: '–',
|
||||||
|
end: '–',
|
||||||
|
duration: '–',
|
||||||
|
warnings: warningCount,
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
const { flatOrder } = state.preview.rundown;
|
const { entries, flatOrder } = state.preview.rundown;
|
||||||
const { start, end, duration } = state.preview.summary;
|
const { start, end, duration } = state.preview.summary;
|
||||||
return `entries: ${flatOrder.length} | start: ${millisToString(start)} | end: ${millisToString(end)} | duration: ${formatDuration(duration)}${warningText}`;
|
let groups = 0;
|
||||||
|
let milestones = 0;
|
||||||
|
for (const entryId of flatOrder) {
|
||||||
|
const entry = entries[entryId];
|
||||||
|
if (isOntimeGroup(entry)) groups++;
|
||||||
|
else if (isOntimeMilestone(entry)) milestones++;
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
entries: flatOrder.length,
|
||||||
|
groups,
|
||||||
|
milestones,
|
||||||
|
start: removeTrailingZero(millisToString(start)),
|
||||||
|
end: removeTrailingZero(millisToString(end)),
|
||||||
|
duration: formatDuration(duration),
|
||||||
|
warnings: warningCount,
|
||||||
|
};
|
||||||
})();
|
})();
|
||||||
|
|
||||||
return {
|
return {
|
||||||
@@ -289,6 +350,10 @@ export function useSheetImportForm({
|
|||||||
isBusy,
|
isBusy,
|
||||||
canPreview,
|
canPreview,
|
||||||
displayError,
|
displayError,
|
||||||
|
importMode,
|
||||||
|
setImportMode,
|
||||||
|
newRundownTitle,
|
||||||
|
setNewRundownTitle,
|
||||||
handlePreviewSubmit: handleSubmit(handlePreview),
|
handlePreviewSubmit: handleSubmit(handlePreview),
|
||||||
handleExportSubmit: handleSubmit(handleExport),
|
handleExportSubmit: handleSubmit(handleExport),
|
||||||
handleApply,
|
handleApply,
|
||||||
|
|||||||
+9
-22
@@ -1,30 +1,17 @@
|
|||||||
import { useQueryClient } from '@tanstack/react-query';
|
import { RundownImportPayload } from 'ontime-types';
|
||||||
import { CustomFields, ProjectRundowns } from 'ontime-types';
|
|
||||||
import { useCallback } from 'react';
|
import { useCallback } from 'react';
|
||||||
|
|
||||||
import { CUSTOM_FIELDS, RUNDOWN } from '../../../../../common/api/constants';
|
import { importRundownWithOptions } from '../../../../../common/api/rundown';
|
||||||
import { patchData } from '../../../../../common/api/db';
|
|
||||||
|
|
||||||
export default function useSpreadsheetImport() {
|
export default function useSpreadsheetImport() {
|
||||||
const queryClient = useQueryClient();
|
/** applies a spreadsheet import: override or merge into the current rundown, or create a new one */
|
||||||
|
const applyImport = useCallback(async (payload: RundownImportPayload) => {
|
||||||
/** applies rundown and customFields to current project */
|
// the backend broadcasts a refetch once the rundown is parsed and applied, so the caches update
|
||||||
const importRundown = useCallback(
|
// through that single path rather than racing it with an optimistic write from here
|
||||||
async (rundowns: ProjectRundowns, customFields: CustomFields) => {
|
await importRundownWithOptions(payload);
|
||||||
await patchData({ rundowns, customFields });
|
}, []);
|
||||||
// we are unable to optimistically set the rundown since we need
|
|
||||||
// it to be normalised
|
|
||||||
await queryClient.invalidateQueries({
|
|
||||||
queryKey: RUNDOWN,
|
|
||||||
});
|
|
||||||
await queryClient.invalidateQueries({
|
|
||||||
queryKey: CUSTOM_FIELDS,
|
|
||||||
});
|
|
||||||
},
|
|
||||||
[queryClient],
|
|
||||||
);
|
|
||||||
|
|
||||||
return {
|
return {
|
||||||
importRundown,
|
applyImport,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,49 @@
|
|||||||
|
import { useEffect, useState } from 'react';
|
||||||
|
|
||||||
|
import { generateUrl } from '../../../../common/api/session';
|
||||||
|
import CopyTag from '../../../../common/components/copy-tag/CopyTag';
|
||||||
|
import { serverURL } from '../../../../externals';
|
||||||
|
import * as Panel from '../../panel-utils/PanelUtils';
|
||||||
|
|
||||||
|
export default function McpSection() {
|
||||||
|
const [mcpEndpointUrl, setMcpEndpointUrl] = useState('');
|
||||||
|
|
||||||
|
// generate url
|
||||||
|
useEffect(() => {
|
||||||
|
// the page origin is reachable wherever the user is browsing from,
|
||||||
|
// and follows the deployment (cloud, reverse proxy, port mappings)
|
||||||
|
// we are reusing the endpoint, so locking config and nav have no effect
|
||||||
|
generateUrl({ baseUrl: serverURL, path: 'mcp', authenticate: true, lockConfig: false, lockNav: false })
|
||||||
|
.then(setMcpEndpointUrl)
|
||||||
|
.catch(() => {
|
||||||
|
setMcpEndpointUrl('');
|
||||||
|
});
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
const mcpClientConfig = mcpEndpointUrl
|
||||||
|
? JSON.stringify({ mcpServers: { ontime: { url: mcpEndpointUrl } } }, null, 2)
|
||||||
|
: '';
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Panel.Section>
|
||||||
|
<Panel.Card>
|
||||||
|
<Panel.SubHeader>MCP Server</Panel.SubHeader>
|
||||||
|
<Panel.Paragraph>Connect any MCP-compatible AI agent to Ontime using the endpoint below.</Panel.Paragraph>
|
||||||
|
<Panel.Divider />
|
||||||
|
<Panel.ListGroup>
|
||||||
|
<Panel.ListItem>
|
||||||
|
<Panel.Field title='Endpoint URL' description='Add this URL to your MCP client settings' />
|
||||||
|
{mcpEndpointUrl && <CopyTag copyValue={mcpEndpointUrl}>{mcpEndpointUrl}</CopyTag>}
|
||||||
|
</Panel.ListItem>
|
||||||
|
<Panel.ListItem>
|
||||||
|
<Panel.Field
|
||||||
|
title='Client configuration snippet'
|
||||||
|
description='Paste this into your AI agent settings under "mcpServers"'
|
||||||
|
/>
|
||||||
|
{mcpEndpointUrl && <CopyTag copyValue={mcpClientConfig}>{mcpClientConfig}</CopyTag>}
|
||||||
|
</Panel.ListItem>
|
||||||
|
</Panel.ListGroup>
|
||||||
|
</Panel.Card>
|
||||||
|
</Panel.Section>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -4,6 +4,7 @@ import type { PanelBaseProps } from '../../panel-list/PanelList';
|
|||||||
import * as Panel from '../../panel-utils/PanelUtils';
|
import * as Panel from '../../panel-utils/PanelUtils';
|
||||||
import CustomViews from '../manage-panel/CustomViews';
|
import CustomViews from '../manage-panel/CustomViews';
|
||||||
import GeneralSettings from './GeneralSettings';
|
import GeneralSettings from './GeneralSettings';
|
||||||
|
import McpSection from './McpSection';
|
||||||
import ProjectData from './ProjectData';
|
import ProjectData from './ProjectData';
|
||||||
import ServerPortSettings from './ServerPortSettings';
|
import ServerPortSettings from './ServerPortSettings';
|
||||||
import ViewSettings from './ViewSettings';
|
import ViewSettings from './ViewSettings';
|
||||||
@@ -13,6 +14,7 @@ export default function SettingsPanel({ location }: PanelBaseProps) {
|
|||||||
const generalRef = useScrollIntoView<HTMLDivElement>('general', location);
|
const generalRef = useScrollIntoView<HTMLDivElement>('general', location);
|
||||||
const viewRef = useScrollIntoView<HTMLDivElement>('view', location);
|
const viewRef = useScrollIntoView<HTMLDivElement>('view', location);
|
||||||
const customViewsRef = useScrollIntoView<HTMLDivElement>('custom-views', location);
|
const customViewsRef = useScrollIntoView<HTMLDivElement>('custom-views', location);
|
||||||
|
const mcpRef = useScrollIntoView<HTMLDivElement>('mcp', location);
|
||||||
const portRef = useScrollIntoView<HTMLDivElement>('port', location);
|
const portRef = useScrollIntoView<HTMLDivElement>('port', location);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
@@ -30,6 +32,9 @@ export default function SettingsPanel({ location }: PanelBaseProps) {
|
|||||||
<div ref={customViewsRef}>
|
<div ref={customViewsRef}>
|
||||||
<CustomViews />
|
<CustomViews />
|
||||||
</div>
|
</div>
|
||||||
|
<div ref={mcpRef}>
|
||||||
|
<McpSection />
|
||||||
|
</div>
|
||||||
{!isDocker && (
|
{!isDocker && (
|
||||||
<div ref={portRef}>
|
<div ref={portRef}>
|
||||||
<ServerPortSettings />
|
<ServerPortSettings />
|
||||||
|
|||||||
+3
@@ -0,0 +1,3 @@
|
|||||||
|
.footer {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
+28
-14
@@ -1,5 +1,5 @@
|
|||||||
import { TranslationObject, langEn } from 'ontime-types';
|
import { TranslationObject, langEn } from 'ontime-types';
|
||||||
import { useMemo } from 'react';
|
import { useEffect, useMemo } from 'react';
|
||||||
import { useForm } from 'react-hook-form';
|
import { useForm } from 'react-hook-form';
|
||||||
|
|
||||||
import { maybeAxiosError } from '../../../../../common/api/utils';
|
import { maybeAxiosError } from '../../../../../common/api/utils';
|
||||||
@@ -10,6 +10,8 @@ import Modal from '../../../../../common/components/modal/Modal';
|
|||||||
import { useTranslation } from '../../../../../translation/TranslationProvider';
|
import { useTranslation } from '../../../../../translation/TranslationProvider';
|
||||||
import * as Panel from '../../../panel-utils/PanelUtils';
|
import * as Panel from '../../../panel-utils/PanelUtils';
|
||||||
|
|
||||||
|
import style from './CustomTranslationModal.module.scss';
|
||||||
|
|
||||||
interface CustomTranslationModalProps {
|
interface CustomTranslationModalProps {
|
||||||
isOpen: boolean;
|
isOpen: boolean;
|
||||||
onClose: () => void;
|
onClose: () => void;
|
||||||
@@ -17,14 +19,7 @@ interface CustomTranslationModalProps {
|
|||||||
|
|
||||||
export default function CustomTranslationModal({ isOpen, onClose }: CustomTranslationModalProps) {
|
export default function CustomTranslationModal({ isOpen, onClose }: CustomTranslationModalProps) {
|
||||||
const { userTranslation, postUserTranslation } = useTranslation();
|
const { userTranslation, postUserTranslation } = useTranslation();
|
||||||
|
const customTranslationFormValues = useMemo(() => toFormValues(userTranslation), [userTranslation]);
|
||||||
const defaultValues = useMemo(() => {
|
|
||||||
const values: Record<string, string> = {};
|
|
||||||
Object.keys(langEn).forEach((key) => {
|
|
||||||
values[toFormKey(key)] = userTranslation[key as keyof TranslationObject] || '';
|
|
||||||
});
|
|
||||||
return values;
|
|
||||||
}, [userTranslation]);
|
|
||||||
|
|
||||||
const {
|
const {
|
||||||
handleSubmit,
|
handleSubmit,
|
||||||
@@ -33,13 +28,17 @@ export default function CustomTranslationModal({ isOpen, onClose }: CustomTransl
|
|||||||
formState: { isSubmitting, isDirty, errors, isValid },
|
formState: { isSubmitting, isDirty, errors, isValid },
|
||||||
setError,
|
setError,
|
||||||
} = useForm({
|
} = useForm({
|
||||||
defaultValues,
|
defaultValues: customTranslationFormValues,
|
||||||
resetOptions: {
|
|
||||||
keepDirtyValues: true,
|
|
||||||
},
|
|
||||||
mode: 'onChange',
|
mode: 'onChange',
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// keep data up to date
|
||||||
|
useEffect(() => {
|
||||||
|
if (isOpen) {
|
||||||
|
reset(customTranslationFormValues);
|
||||||
|
}
|
||||||
|
}, [customTranslationFormValues, isOpen, reset]);
|
||||||
|
|
||||||
const onSubmit = async (formData: Record<string, string>) => {
|
const onSubmit = async (formData: Record<string, string>) => {
|
||||||
try {
|
try {
|
||||||
const translationData: Record<string, string> = {};
|
const translationData: Record<string, string> = {};
|
||||||
@@ -54,6 +53,10 @@ export default function CustomTranslationModal({ isOpen, onClose }: CustomTransl
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
const resetToEnglish = () => {
|
||||||
|
reset(toFormValues(langEn), { keepDefaultValues: true });
|
||||||
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Modal
|
<Modal
|
||||||
title='Edit custom translations'
|
title='Edit custom translations'
|
||||||
@@ -84,9 +87,12 @@ export default function CustomTranslationModal({ isOpen, onClose }: CustomTransl
|
|||||||
</Panel.Section>
|
</Panel.Section>
|
||||||
}
|
}
|
||||||
footerElements={
|
footerElements={
|
||||||
<div>
|
<div className={style.footer}>
|
||||||
{errors?.root && <Panel.Error>{errors.root.message}</Panel.Error>}
|
{errors?.root && <Panel.Error>{errors.root.message}</Panel.Error>}
|
||||||
<Panel.InlineElements align='apart'>
|
<Panel.InlineElements align='apart'>
|
||||||
|
<Button variant='ghosted' size='large' onClick={resetToEnglish} disabled={isSubmitting}>
|
||||||
|
Reset to English
|
||||||
|
</Button>
|
||||||
<Panel.InlineElements>
|
<Panel.InlineElements>
|
||||||
<Button size='large' onClick={onClose}>
|
<Button size='large' onClick={onClose}>
|
||||||
Cancel
|
Cancel
|
||||||
@@ -109,6 +115,14 @@ export default function CustomTranslationModal({ isOpen, onClose }: CustomTransl
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function toFormValues(translation: Partial<TranslationObject>) {
|
||||||
|
const values: Record<string, string> = {};
|
||||||
|
Object.keys(langEn).forEach((key) => {
|
||||||
|
values[toFormKey(key)] = translation[key as keyof TranslationObject] || '';
|
||||||
|
});
|
||||||
|
return values;
|
||||||
|
}
|
||||||
|
|
||||||
function toFormKey(key: string) {
|
function toFormKey(key: string) {
|
||||||
return key.replace('.', '_');
|
return key.replace('.', '_');
|
||||||
}
|
}
|
||||||
|
|||||||
+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;
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -20,13 +19,13 @@ const staticOptions = [
|
|||||||
{ id: 'settings__general', label: 'General settings' },
|
{ id: 'settings__general', label: 'General settings' },
|
||||||
{ id: 'settings__view', label: 'View settings' },
|
{ id: 'settings__view', label: 'View settings' },
|
||||||
{ id: 'settings__custom-views', label: 'Custom views' },
|
{ id: 'settings__custom-views', label: 'Custom views' },
|
||||||
{ id: 'settings__port', label: 'Server port' },
|
{ id: 'settings__mcp', label: 'MCP Server' },
|
||||||
|
...(isDocker ? [] : [{ id: 'settings__port', label: 'Server port' }]),
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
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 +45,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 +54,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 +66,6 @@ const staticOptions = [
|
|||||||
{
|
{
|
||||||
id: 'network',
|
id: 'network',
|
||||||
label: 'Network',
|
label: 'Network',
|
||||||
split: true,
|
|
||||||
secondary: [
|
secondary: [
|
||||||
{
|
{
|
||||||
id: 'network__log',
|
id: 'network__log',
|
||||||
@@ -84,12 +80,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;
|
||||||
|
|
||||||
@@ -103,18 +97,12 @@ export function useAppSettingsMenu() {
|
|||||||
|
|
||||||
const options: Readonly<SettingsOption[]> = useMemo(
|
const options: Readonly<SettingsOption[]> = useMemo(
|
||||||
() =>
|
() =>
|
||||||
staticOptions.map((option) => ({
|
staticOptions.map((option) =>
|
||||||
...option,
|
|
||||||
// if we are in docker don't show the port option
|
|
||||||
secondary:
|
|
||||||
'secondary' in option
|
|
||||||
? isDocker && option.id === 'settings'
|
|
||||||
? [...option.secondary.filter(({ id }) => id !== 'settings__port')]
|
|
||||||
: [...option.secondary]
|
|
||||||
: undefined,
|
|
||||||
// if there is an update then highlight the about setting
|
// if there is an update then highlight the about setting
|
||||||
highlight: option.id === 'about' && data.hasUpdates ? 'New version available' : undefined,
|
option.id === 'about' && data.hasUpdates
|
||||||
})),
|
? Object.assign({}, option, { highlight: 'New version available' })
|
||||||
|
: option,
|
||||||
|
),
|
||||||
[data],
|
[data],
|
||||||
);
|
);
|
||||||
|
|
||||||
|
|||||||
@@ -73,6 +73,10 @@
|
|||||||
margin-right: 0.25rem;
|
margin-right: 0.25rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.tagOvertime {
|
||||||
|
color: $playback-over;
|
||||||
|
}
|
||||||
|
|
||||||
.time {
|
.time {
|
||||||
color: $section-white;
|
color: $section-white;
|
||||||
font-size: $text-body-size;
|
font-size: $text-body-size;
|
||||||
|
|||||||
@@ -1,12 +1,13 @@
|
|||||||
import { MaybeNumber, Playback, TimerPhase } from 'ontime-types';
|
import { MaybeNumber, Playback, TimerPhase } from 'ontime-types';
|
||||||
import { dayInMs, millisToString } from 'ontime-utils';
|
import { millisToString } from 'ontime-utils';
|
||||||
import { PropsWithChildren } from 'react';
|
import { PropsWithChildren } from 'react';
|
||||||
|
|
||||||
import AppLink from '../../../../common/components/link/app-link/AppLink';
|
import AppLink from '../../../../common/components/link/app-link/AppLink';
|
||||||
import Tooltip from '../../../../common/components/tooltip/Tooltip';
|
import Tooltip from '../../../../common/components/tooltip/Tooltip';
|
||||||
import useReport from '../../../../common/hooks-query/useReport';
|
import useReport from '../../../../common/hooks-query/useReport';
|
||||||
import { useTimer } from '../../../../common/hooks/useSocket';
|
import { useTimerProgress } from '../../../../common/hooks/useSocket';
|
||||||
import { formatDuration } from '../../../../common/utils/time';
|
import { cx } from '../../../../common/utils/styleUtils';
|
||||||
|
import { formatDuration, normaliseWallClock } from '../../../../common/utils/time';
|
||||||
import TimerDisplay from '../timer-display/TimerDisplay';
|
import TimerDisplay from '../timer-display/TimerDisplay';
|
||||||
|
|
||||||
import style from './PlaybackTimer.module.scss';
|
import style from './PlaybackTimer.module.scss';
|
||||||
@@ -24,15 +25,14 @@ function resolveAddedTimeLabel(addedTime: number) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export default function PlaybackTimer({ children }: PropsWithChildren) {
|
export default function PlaybackTimer({ children }: PropsWithChildren) {
|
||||||
const timer = useTimer();
|
'use memo';
|
||||||
|
const timer = useTimerProgress();
|
||||||
|
|
||||||
const isRolling = timer.playback === Playback.Roll;
|
const isRolling = timer.playback === Playback.Roll;
|
||||||
const isWaiting = timer.phase === TimerPhase.Pending;
|
const isWaiting = timer.phase === TimerPhase.Pending;
|
||||||
const isOvertime = timer.phase === TimerPhase.Overtime;
|
const isOvertime = timer.phase === TimerPhase.Overtime;
|
||||||
const hasAddedTime = Boolean(timer.addedTime);
|
const hasAddedTime = Boolean(timer.addedTime);
|
||||||
|
|
||||||
const rollLabel = isRolling ? 'Roll mode active' : '';
|
const rollLabel = isRolling ? 'Roll mode active' : '';
|
||||||
|
|
||||||
const addedTimeLabel = resolveAddedTimeLabel(timer.addedTime);
|
const addedTimeLabel = resolveAddedTimeLabel(timer.addedTime);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
@@ -51,7 +51,13 @@ export default function PlaybackTimer({ children }: PropsWithChildren) {
|
|||||||
{isWaiting ? (
|
{isWaiting ? (
|
||||||
<span className={style.rolltag}>Roll: Countdown to start</span>
|
<span className={style.rolltag}>Roll: Countdown to start</span>
|
||||||
) : (
|
) : (
|
||||||
<RunningStatus startedAt={timer.startedAt} expectedFinish={timer.expectedFinish} playback={timer.playback} />
|
<RunningStatus
|
||||||
|
startedAt={timer.startedAt}
|
||||||
|
expectedFinish={timer.expectedFinish}
|
||||||
|
isStopped={timer.playback === Playback.Stop}
|
||||||
|
isCountToEnd={timer.isCountToEnd}
|
||||||
|
isOvertime={isOvertime}
|
||||||
|
/>
|
||||||
)}
|
)}
|
||||||
</div>
|
</div>
|
||||||
{children}
|
{children}
|
||||||
@@ -62,16 +68,18 @@ export default function PlaybackTimer({ children }: PropsWithChildren) {
|
|||||||
interface RunningStatusProps {
|
interface RunningStatusProps {
|
||||||
startedAt: MaybeNumber;
|
startedAt: MaybeNumber;
|
||||||
expectedFinish: MaybeNumber;
|
expectedFinish: MaybeNumber;
|
||||||
playback: Playback;
|
isStopped: boolean;
|
||||||
|
isCountToEnd: boolean;
|
||||||
|
isOvertime: boolean;
|
||||||
}
|
}
|
||||||
function RunningStatus({ startedAt, expectedFinish, playback }: RunningStatusProps) {
|
|
||||||
if (playback === Playback.Stop) {
|
function RunningStatus({ startedAt, expectedFinish, isStopped, isCountToEnd, isOvertime }: RunningStatusProps) {
|
||||||
|
if (isStopped) {
|
||||||
return <StoppedStatus />;
|
return <StoppedStatus />;
|
||||||
}
|
}
|
||||||
|
|
||||||
const started = millisToString(startedAt);
|
const started = millisToString(startedAt);
|
||||||
const finishedMs = expectedFinish !== null ? expectedFinish % dayInMs : null;
|
const finish = millisToString(expectedFinish === null ? null : normaliseWallClock(expectedFinish));
|
||||||
const finish = millisToString(finishedMs);
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
@@ -80,7 +88,9 @@ function RunningStatus({ startedAt, expectedFinish, playback }: RunningStatusPro
|
|||||||
<span className={style.time}>{started}</span>
|
<span className={style.time}>{started}</span>
|
||||||
</span>
|
</span>
|
||||||
<span className={style.finish}>
|
<span className={style.finish}>
|
||||||
<span className={style.tag}>Expect end</span>
|
<span className={cx([style.tag, isOvertime && style.tagOvertime])}>
|
||||||
|
{isCountToEnd ? 'Scheduled end' : 'Expected end'}
|
||||||
|
</span>
|
||||||
<span className={style.time}>{finish}</span>
|
<span className={style.time}>{finish}</span>
|
||||||
</span>
|
</span>
|
||||||
</>
|
</>
|
||||||
|
|||||||
@@ -180,7 +180,13 @@ function Operator({ rundown, rundownMetadata, customFields, settings }: Operator
|
|||||||
|
|
||||||
return (
|
return (
|
||||||
<Fragment key={entry.id}>
|
<Fragment key={entry.id}>
|
||||||
<OperatorGroup key={entry.id} title={entry.title} />
|
<OperatorGroup
|
||||||
|
key={entry.id}
|
||||||
|
title={entry.title}
|
||||||
|
colour={entry.colour}
|
||||||
|
count={entry.entries.length}
|
||||||
|
duration={entry.duration}
|
||||||
|
/>
|
||||||
{entry.entries.map((nestedEntryId) => {
|
{entry.entries.map((nestedEntryId) => {
|
||||||
const nestedEntry = rundown.entries[nestedEntryId];
|
const nestedEntry = rundown.entries[nestedEntryId];
|
||||||
if (!isOntimeEvent(nestedEntry)) {
|
if (!isOntimeEvent(nestedEntry)) {
|
||||||
@@ -217,6 +223,7 @@ function Operator({ rundown, rundownMetadata, customFields, settings }: Operator
|
|||||||
isLinkedToLoaded={isLinkedToLoaded}
|
isLinkedToLoaded={isLinkedToLoaded}
|
||||||
isSelected={isLoaded}
|
isSelected={isLoaded}
|
||||||
isPast={isPast}
|
isPast={isPast}
|
||||||
|
groupColour={entry.colour}
|
||||||
selectedRef={isLoaded ? selectedRef : undefined}
|
selectedRef={isLoaded ? selectedRef : undefined}
|
||||||
showStart={showStart}
|
showStart={showStart}
|
||||||
subscribed={subscribedData}
|
subscribed={subscribedData}
|
||||||
|
|||||||
@@ -22,17 +22,39 @@
|
|||||||
background-color: $gray-1250;
|
background-color: $gray-1250;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
&.grouped {
|
||||||
|
position: relative;
|
||||||
|
padding-left: 0.35rem;
|
||||||
|
background:
|
||||||
|
linear-gradient(90deg, color-mix(in srgb, transparent 88%, var(--group-colour, $gray-500) 12%), transparent 8rem),
|
||||||
|
$viewer-card-bg-color;
|
||||||
|
}
|
||||||
|
|
||||||
&.running {
|
&.running {
|
||||||
border-top: 1px solid $gray-1300;
|
border-top: 1px solid $gray-1300;
|
||||||
background-color: var(--operator-running-bg-override, $active-green);
|
background-color: var(--operator-running-bg-override, $active-green);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
&.grouped.running {
|
||||||
|
background:
|
||||||
|
linear-gradient(90deg, color-mix(in srgb, transparent 82%, var(--group-colour, $gray-500) 18%), transparent 8rem),
|
||||||
|
var(--operator-running-bg-override, $active-green);
|
||||||
|
}
|
||||||
|
|
||||||
&.past {
|
&.past {
|
||||||
border-top: 1px solid transparent;
|
border-top: 1px solid transparent;
|
||||||
opacity: 0.2;
|
opacity: 0.2;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.groupRail {
|
||||||
|
position: absolute;
|
||||||
|
inset-block: 0;
|
||||||
|
left: 0;
|
||||||
|
width: 0.35rem;
|
||||||
|
background-color: var(--group-colour, $gray-500);
|
||||||
|
}
|
||||||
|
|
||||||
.binder {
|
.binder {
|
||||||
grid-area: binder;
|
grid-area: binder;
|
||||||
color: $section-white;
|
color: $section-white;
|
||||||
@@ -74,6 +96,9 @@
|
|||||||
.plannedStart,
|
.plannedStart,
|
||||||
.timeUntil,
|
.timeUntil,
|
||||||
.runningTime {
|
.runningTime {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.25rem;
|
||||||
border-radius: $component-border-radius-md;
|
border-radius: $component-border-radius-md;
|
||||||
padding: 0.25rem 0.5rem;
|
padding: 0.25rem 0.5rem;
|
||||||
line-height: 1;
|
line-height: 1;
|
||||||
@@ -95,6 +120,21 @@
|
|||||||
letter-spacing: 1px;
|
letter-spacing: 1px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.live {
|
||||||
|
color: $ui-black;
|
||||||
|
background-color: $ui-white;
|
||||||
|
}
|
||||||
|
|
||||||
|
.due {
|
||||||
|
color: $ui-black;
|
||||||
|
background-color: $orange-500;
|
||||||
|
}
|
||||||
|
|
||||||
|
.done {
|
||||||
|
color: $white-60;
|
||||||
|
background-color: $white-7;
|
||||||
|
}
|
||||||
|
|
||||||
.runningTime {
|
.runningTime {
|
||||||
grid-area: running;
|
grid-area: running;
|
||||||
font-size: 1.25rem;
|
font-size: 1.25rem;
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user