mirror of
https://github.com/cpvalente/ontime.git
synced 2026-09-10 16:49:41 +00:00
Compare commits
13 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| ccdfb64921 | |||
| a5086aed0b | |||
| 1fa6175fb8 | |||
| bc8407c0e6 | |||
| 802521c706 | |||
| 9ec12f4927 | |||
| 4c08ca2908 | |||
| 265b167600 | |||
| eb7b2a5c4b | |||
| e0ae9f7f09 | |||
| b0c778fa62 | |||
| 98d3b1f6f3 | |||
| d9dd147d4b |
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@getontime/cli",
|
"name": "@getontime/cli",
|
||||||
"version": "4.12.0",
|
"version": "4.13.0",
|
||||||
"author": "Carlos Valente",
|
"author": "Carlos Valente",
|
||||||
"description": "Time keeping for live events",
|
"description": "Time keeping for live events",
|
||||||
"repository": "https://github.com/cpvalente/ontime",
|
"repository": "https://github.com/cpvalente/ontime",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "ontime-ui",
|
"name": "ontime-ui",
|
||||||
"version": "4.12.0",
|
"version": "4.13.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ import { ComponentType, Suspense, lazy, useEffect, useMemo } from 'react';
|
|||||||
import { Navigate, Route, useLocation, useNavigate, useParams } from 'react-router';
|
import { Navigate, Route, useLocation, useNavigate, useParams } from 'react-router';
|
||||||
|
|
||||||
import ViewNavigationMenu from './common/components/navigation-menu/ViewNavigationMenu';
|
import ViewNavigationMenu from './common/components/navigation-menu/ViewNavigationMenu';
|
||||||
|
import { EditableRundownScopeProvider } from './common/context/EditableRundownScopeProvider';
|
||||||
import { PresetContext } from './common/context/PresetContext';
|
import { PresetContext } from './common/context/PresetContext';
|
||||||
import useUrlPresets from './common/hooks-query/useUrlPresets';
|
import useUrlPresets from './common/hooks-query/useUrlPresets';
|
||||||
import { useClientPath } from './common/hooks/useClientPath';
|
import { useClientPath } from './common/hooks/useClientPath';
|
||||||
@@ -112,7 +113,9 @@ export default function AppRouter() {
|
|||||||
path='rundown'
|
path='rundown'
|
||||||
element={
|
element={
|
||||||
<EditorFeatureWrapper>
|
<EditorFeatureWrapper>
|
||||||
<RundownPanel />
|
<EditableRundownScopeProvider rundownId={null}>
|
||||||
|
<RundownPanel />
|
||||||
|
</EditableRundownScopeProvider>
|
||||||
</EditorFeatureWrapper>
|
</EditorFeatureWrapper>
|
||||||
}
|
}
|
||||||
/>
|
/>
|
||||||
|
|||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -22,6 +22,14 @@ export const CLIENT_LIST = ['clientList'];
|
|||||||
export const REPORT = ['report'];
|
export const REPORT = ['report'];
|
||||||
export const TRANSLATION = ['translation'];
|
export const TRANSLATION = ['translation'];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Cache key holding the data for a rundown.
|
||||||
|
* Before the loaded rundown is known there is no id to key by,
|
||||||
|
* and the data lives under the bootstrap alias.
|
||||||
|
*/
|
||||||
|
export const getRundownCacheKey = (rundownId: string) =>
|
||||||
|
rundownId ? getRundownQueryKey(rundownId) : CURRENT_RUNDOWN_QUERY_KEY;
|
||||||
|
|
||||||
// API URLs
|
// API URLs
|
||||||
export const apiEntryUrl = `${serverURL}/data`;
|
export const apiEntryUrl = `${serverURL}/data`;
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,18 @@
|
|||||||
|
import { ComponentProps } from 'react';
|
||||||
|
|
||||||
|
import Button from './Button';
|
||||||
|
|
||||||
|
type ToggleButtonProps = Omit<ComponentProps<typeof Button>, 'variant'> & {
|
||||||
|
/** whether the option this button controls is currently on */
|
||||||
|
pressed: boolean;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A button which carries an on / off state.
|
||||||
|
*
|
||||||
|
* Keeps the pressed styling and the accessible state together, so that a toggle
|
||||||
|
* cannot end up looking active without also announcing that it is.
|
||||||
|
*/
|
||||||
|
export default function ToggleButton({ pressed, ...buttonProps }: ToggleButtonProps) {
|
||||||
|
return <Button variant={pressed ? 'primary' : 'subtle'} aria-pressed={pressed} {...buttonProps} />;
|
||||||
|
}
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
import { PropsWithChildren } from 'react';
|
||||||
|
|
||||||
|
import { useScopedEntryActions } from '../hooks/useEntryAction';
|
||||||
|
import { EntryActionsProvider } from './EntryActionsContext';
|
||||||
|
import { RundownScopeProvider, useRundownScope, type RundownScopeProviderProps } from './RundownScopeContext';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Rundown scope for subtrees which mutate entries.
|
||||||
|
* Actions are bound to the same rundown as the data, so the two cannot disagree.
|
||||||
|
*/
|
||||||
|
export function EditableRundownScopeProvider({ children, rundownId }: RundownScopeProviderProps) {
|
||||||
|
return (
|
||||||
|
<RundownScopeProvider rundownId={rundownId}>
|
||||||
|
<ScopedEntryActions>{children}</ScopedEntryActions>
|
||||||
|
</RundownScopeProvider>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function ScopedEntryActions({ children }: PropsWithChildren) {
|
||||||
|
const { rundownId } = useRundownScope();
|
||||||
|
const actions = useScopedEntryActions(rundownId);
|
||||||
|
|
||||||
|
return <EntryActionsProvider actions={actions}>{children}</EntryActionsProvider>;
|
||||||
|
}
|
||||||
@@ -0,0 +1,77 @@
|
|||||||
|
import { MaybeString, Rundown } from 'ontime-types';
|
||||||
|
import { PropsWithChildren, createContext, useContext, useEffect, useMemo, useRef } from 'react';
|
||||||
|
|
||||||
|
import { getRundownCacheKey } from '../api/constants';
|
||||||
|
import { useProjectRundowns } from '../hooks-query/useProjectRundowns';
|
||||||
|
import { ontimeQueryClient } from '../queryClient';
|
||||||
|
import { createEventSelectionStore, type EventSelectionStoreApi } from '../stores/eventSelectionStore';
|
||||||
|
|
||||||
|
export type RundownScopeValue = {
|
||||||
|
/** the rundown this subtree operates on */
|
||||||
|
rundownId: string;
|
||||||
|
/** whether this scope targets the rundown the runtime is playing */
|
||||||
|
isLoaded: boolean;
|
||||||
|
/** selection and cursor, scoped to this rundown */
|
||||||
|
selectionStore: EventSelectionStoreApi;
|
||||||
|
};
|
||||||
|
|
||||||
|
const RundownScopeContext = createContext<RundownScopeValue | null>(null);
|
||||||
|
|
||||||
|
export interface RundownScopeProviderProps extends PropsWithChildren {
|
||||||
|
/** rundown to operate on, null follows the loaded rundown */
|
||||||
|
rundownId: MaybeString;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Declares which rundown a subtree reads from.
|
||||||
|
*
|
||||||
|
* Data hooks resolve their rundown from here, so components never need to know
|
||||||
|
* which rundown they operate on. Nest a provider to point part of the tree at a
|
||||||
|
* different rundown; the app mounts one at the root that follows the loaded rundown.
|
||||||
|
*/
|
||||||
|
export function RundownScopeProvider({ children, rundownId }: RundownScopeProviderProps) {
|
||||||
|
const {
|
||||||
|
data: { loaded },
|
||||||
|
} = useProjectRundowns();
|
||||||
|
|
||||||
|
const targetId = rundownId ?? loaded;
|
||||||
|
|
||||||
|
// the store reads the rundown lazily, the ref keeps it pointing at the current target
|
||||||
|
const targetIdRef = useRef(targetId);
|
||||||
|
|
||||||
|
const selectionStoreRef = useRef<EventSelectionStoreApi | null>(null);
|
||||||
|
if (selectionStoreRef.current === null) {
|
||||||
|
selectionStoreRef.current = createEventSelectionStore(() =>
|
||||||
|
ontimeQueryClient.getQueryData<Rundown>(getRundownCacheKey(targetIdRef.current)),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const selectionStore = selectionStoreRef.current;
|
||||||
|
|
||||||
|
// a selection refers to entries of a single rundown, it cannot survive a change of target
|
||||||
|
useEffect(() => {
|
||||||
|
targetIdRef.current = targetId;
|
||||||
|
selectionStore.getState().clearSelectedEvents();
|
||||||
|
}, [selectionStore, targetId]);
|
||||||
|
|
||||||
|
const value = useMemo(
|
||||||
|
(): RundownScopeValue => ({
|
||||||
|
rundownId: targetId,
|
||||||
|
// an unresolved target is not the loaded rundown, it is not yet any rundown
|
||||||
|
isLoaded: Boolean(loaded) && targetId === loaded,
|
||||||
|
selectionStore,
|
||||||
|
}),
|
||||||
|
[targetId, loaded, selectionStore],
|
||||||
|
);
|
||||||
|
|
||||||
|
return <RundownScopeContext.Provider value={value}>{children}</RundownScopeContext.Provider>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useRundownScope(): RundownScopeValue {
|
||||||
|
const context = useContext(RundownScopeContext);
|
||||||
|
|
||||||
|
if (!context) {
|
||||||
|
throw new Error('useRundownScope must be used within a RundownScopeProvider');
|
||||||
|
}
|
||||||
|
|
||||||
|
return context;
|
||||||
|
}
|
||||||
@@ -0,0 +1,81 @@
|
|||||||
|
import { EntryId, OntimeEntry } from 'ontime-types';
|
||||||
|
import { useMemo } from 'react';
|
||||||
|
|
||||||
|
import { useSelectedEventId } from '../hooks/useSocket';
|
||||||
|
import { ExtendedEntry, getFlatRundownMetadata, getRundownMetadata } from '../utils/rundownMetadata';
|
||||||
|
import { useProjectRundowns } from './useProjectRundowns';
|
||||||
|
import { flattenRundown, useRundownById } from './useRundownById';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Rundown data for surfaces which only ever work against the rundown being played:
|
||||||
|
* the viewers, the operator, app settings and the runtime overview.
|
||||||
|
*
|
||||||
|
* These take no part in a rundown scope, they resolve the loaded rundown directly.
|
||||||
|
* Anything which can be pointed at a background rundown reads from its scope instead.
|
||||||
|
*/
|
||||||
|
export function useLoadedRundown() {
|
||||||
|
const {
|
||||||
|
data: { loaded },
|
||||||
|
} = useProjectRundowns();
|
||||||
|
return useRundownById(loaded);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useLoadedRundownWithMetadata() {
|
||||||
|
const { data, status } = useLoadedRundown();
|
||||||
|
const selectedEventId = useSelectedEventId();
|
||||||
|
const { entries, flatOrder } = data;
|
||||||
|
const rundownMetadata = useMemo(
|
||||||
|
() => getRundownMetadata({ entries, flatOrder }, selectedEventId),
|
||||||
|
[entries, flatOrder, selectedEventId],
|
||||||
|
);
|
||||||
|
return { data, status, rundownMetadata };
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useLoadedFlatRundown() {
|
||||||
|
const { data, status } = useLoadedRundown();
|
||||||
|
const flatRundown = useMemo(() => flattenRundown(data), [data]);
|
||||||
|
return { data: flatRundown, rundownId: data.id, status };
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useLoadedFlatRundownWithMetadata() {
|
||||||
|
const { data, status } = useLoadedRundown();
|
||||||
|
const selectedEventId = useSelectedEventId();
|
||||||
|
const { entries, flatOrder } = data;
|
||||||
|
const rundownWithMetadata = useMemo(
|
||||||
|
() => getFlatRundownMetadata({ entries, flatOrder }, selectedEventId),
|
||||||
|
[entries, flatOrder, selectedEventId],
|
||||||
|
);
|
||||||
|
return { data: rundownWithMetadata, status };
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides access to a partial rundown based on a filter callback
|
||||||
|
*
|
||||||
|
* Callers MUST memoize the callback with useCallback to prevent
|
||||||
|
* re-filtering on every render.
|
||||||
|
*/
|
||||||
|
export function useLoadedPartialRundown(cb: (event: ExtendedEntry<OntimeEntry>) => boolean) {
|
||||||
|
const { data, status } = useLoadedFlatRundownWithMetadata();
|
||||||
|
const filteredData = useMemo(() => data.filter(cb), [data, cb]);
|
||||||
|
return { data: filteredData, status };
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Hook to get a specific entry by ID from the loaded rundown.
|
||||||
|
* Runtime ids (the playing event, its group, the next flag) only exist here.
|
||||||
|
*/
|
||||||
|
export function useLoadedEntry(entryId: EntryId | null): OntimeEntry | null {
|
||||||
|
const { data: rundown } = useLoadedRundown();
|
||||||
|
|
||||||
|
if (entryId === null) return null;
|
||||||
|
return rundown.entries[entryId] ?? null;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useLoadedRundownAuxData() {
|
||||||
|
const { data, status } = useLoadedRundown();
|
||||||
|
const filteredData = useMemo(() => {
|
||||||
|
const { title, id } = data;
|
||||||
|
return { title, id };
|
||||||
|
}, [data]);
|
||||||
|
return { data: filteredData, status };
|
||||||
|
}
|
||||||
@@ -1,62 +1,38 @@
|
|||||||
import { useQuery, useQueryClient } from '@tanstack/react-query';
|
import { EntryId, OntimeEntry } from 'ontime-types';
|
||||||
import { EntryId, OntimeEntry, Rundown } from 'ontime-types';
|
import { useMemo } from 'react';
|
||||||
import { useEffect, useMemo } from 'react';
|
|
||||||
|
|
||||||
import { queryRefetchIntervalSlow } from '../../ontimeConfig';
|
import { useRundownScope } from '../context/RundownScopeContext';
|
||||||
import { CURRENT_RUNDOWN_QUERY_KEY, getRundownQueryKey } from '../api/constants';
|
|
||||||
import { fetchCurrentRundown, fetchRundown } from '../api/rundown';
|
|
||||||
import { useSelectedEventId } from '../hooks/useSocket';
|
import { useSelectedEventId } from '../hooks/useSocket';
|
||||||
import { ExtendedEntry, getFlatRundownMetadata, getRundownMetadata } from '../utils/rundownMetadata';
|
import { getFlatRundownMetadata, getRundownMetadata } from '../utils/rundownMetadata';
|
||||||
import { useProjectRundowns } from './useProjectRundowns';
|
import { flattenRundown, useRundownById } from './useRundownById';
|
||||||
|
|
||||||
// revision is -1 so that the remote revision is higher
|
|
||||||
const cachedRundownPlaceholder: Rundown = {
|
|
||||||
id: 'default',
|
|
||||||
title: '',
|
|
||||||
order: [],
|
|
||||||
flatOrder: [],
|
|
||||||
entries: {},
|
|
||||||
revision: -1,
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Normalised rundown data for the currently loaded rundown.
|
* Normalised rundown data for the rundown of the enclosing scope
|
||||||
*
|
|
||||||
* 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 { rundownId } = useRundownScope();
|
||||||
const {
|
return useRundownById(rundownId);
|
||||||
data: { loaded: loadedRundownId },
|
}
|
||||||
} = useProjectRundowns();
|
|
||||||
|
|
||||||
const { data, status, isError, refetch, isFetching } = useQuery<Rundown>({
|
/**
|
||||||
queryKey: loadedRundownId ? getRundownQueryKey(loadedRundownId) : CURRENT_RUNDOWN_QUERY_KEY,
|
* Runtime state only describes the loaded rundown,
|
||||||
queryFn: ({ signal }) => fetchCurrentRundown({ signal }),
|
* a scope pointed elsewhere must not show a playing event
|
||||||
refetchInterval: queryRefetchIntervalSlow,
|
*/
|
||||||
});
|
export function useScopedSelectedEventId(): EntryId | null {
|
||||||
|
const { isLoaded } = useRundownScope();
|
||||||
// Seed the id-keyed cache when fetching via the bootstrap alias
|
const selectedEventId = useSelectedEventId();
|
||||||
useEffect(() => {
|
return isLoaded ? selectedEventId : null;
|
||||||
if (!data || loadedRundownId) return;
|
|
||||||
queryClient.setQueryData(getRundownQueryKey(data.id), data);
|
|
||||||
}, [data, loadedRundownId, queryClient]);
|
|
||||||
|
|
||||||
// Once we have the ID, drop the temporary current cache
|
|
||||||
useEffect(() => {
|
|
||||||
if (!loadedRundownId) return;
|
|
||||||
queryClient.removeQueries({ queryKey: CURRENT_RUNDOWN_QUERY_KEY, exact: true });
|
|
||||||
}, [loadedRundownId, queryClient]);
|
|
||||||
|
|
||||||
return { data: data ?? cachedRundownPlaceholder, status, isError, refetch, isFetching };
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export function useRundownWithMetadata() {
|
export function useRundownWithMetadata() {
|
||||||
const { data, status } = useRundown();
|
const { data, status } = useRundown();
|
||||||
const selectedEventId = useSelectedEventId();
|
const selectedEventId = useScopedSelectedEventId();
|
||||||
const rundownMetadata = useMemo(() => getRundownMetadata(data, selectedEventId), [data, selectedEventId]);
|
// key on the fields the derivation reads, a revision only change must not churn the list
|
||||||
|
const { entries, flatOrder } = data;
|
||||||
|
const rundownMetadata = useMemo(
|
||||||
|
() => getRundownMetadata({ entries, flatOrder }, selectedEventId),
|
||||||
|
[entries, flatOrder, selectedEventId],
|
||||||
|
);
|
||||||
return { data, status, rundownMetadata };
|
return { data, status, rundownMetadata };
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -66,41 +42,23 @@ export function useRundownWithMetadata() {
|
|||||||
*/
|
*/
|
||||||
export function useFlatRundown() {
|
export function useFlatRundown() {
|
||||||
const { data, status } = useRundown();
|
const { data, status } = useRundown();
|
||||||
|
const flatRundown = useMemo(() => flattenRundown(data), [data]);
|
||||||
const flatRundown = useMemo(() => {
|
|
||||||
if (data.revision === -1) {
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
return data.flatOrder.map((id) => data.entries[id]).filter((entry): entry is OntimeEntry => entry !== undefined);
|
|
||||||
}, [data]);
|
|
||||||
|
|
||||||
return { data: flatRundown, rundownId: data.id, status };
|
return { data: flatRundown, rundownId: data.id, status };
|
||||||
}
|
}
|
||||||
|
|
||||||
export function useFlatRundownWithMetadata() {
|
export function useFlatRundownWithMetadata() {
|
||||||
const { data, status } = useRundown();
|
const { data, status } = useRundown();
|
||||||
const selectedEventId = useSelectedEventId();
|
const selectedEventId = useScopedSelectedEventId();
|
||||||
|
|
||||||
const rundownWithMetadata = useMemo(() => getFlatRundownMetadata(data, selectedEventId), [data, selectedEventId]);
|
const { entries, flatOrder } = data;
|
||||||
|
const rundownWithMetadata = useMemo(
|
||||||
|
() => getFlatRundownMetadata({ entries, flatOrder }, selectedEventId),
|
||||||
|
[entries, flatOrder, selectedEventId],
|
||||||
|
);
|
||||||
return { data: rundownWithMetadata, status };
|
return { data: rundownWithMetadata, status };
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Provides access to a partial rundown based on a filter callback
|
|
||||||
*
|
|
||||||
* Callers MUST memoize the callback with useCallback to prevent
|
|
||||||
* re-filtering on every render.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
export function usePartialRundown(cb: (event: ExtendedEntry<OntimeEntry>) => boolean) {
|
|
||||||
const { data, status } = useFlatRundownWithMetadata();
|
|
||||||
const filteredData = useMemo(() => {
|
|
||||||
return data.filter(cb);
|
|
||||||
}, [data, cb]);
|
|
||||||
|
|
||||||
return { data: filteredData, status };
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Hook to get a specific entry by ID from the rundown
|
* Hook to get a specific entry by ID from the rundown
|
||||||
*/
|
*/
|
||||||
@@ -110,30 +68,3 @@ export function useEntry(entryId: EntryId | null): OntimeEntry | null {
|
|||||||
if (entryId === null) return null;
|
if (entryId === null) return null;
|
||||||
return rundown.entries[entryId] ?? null;
|
return rundown.entries[entryId] ?? null;
|
||||||
}
|
}
|
||||||
|
|
||||||
export function useRundownAuxData() {
|
|
||||||
const { data, status } = useRundown();
|
|
||||||
const filteredData = useMemo(() => {
|
|
||||||
const { title, id } = data;
|
|
||||||
return { title, id };
|
|
||||||
}, [data]);
|
|
||||||
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,66 @@
|
|||||||
|
import { useQuery, useQueryClient } from '@tanstack/react-query';
|
||||||
|
import { OntimeEntry, Rundown } from 'ontime-types';
|
||||||
|
import { useEffect, useRef } from 'react';
|
||||||
|
|
||||||
|
import { queryRefetchIntervalSlow } from '../../ontimeConfig';
|
||||||
|
import { CURRENT_RUNDOWN_QUERY_KEY, getRundownCacheKey, getRundownQueryKey } from '../api/constants';
|
||||||
|
import { fetchCurrentRundown, fetchRundown } from '../api/rundown';
|
||||||
|
|
||||||
|
// revision is -1 so that the remote revision is higher
|
||||||
|
const cachedRundownPlaceholder: Rundown = {
|
||||||
|
id: 'default',
|
||||||
|
title: '',
|
||||||
|
order: [],
|
||||||
|
flatOrder: [],
|
||||||
|
entries: {},
|
||||||
|
revision: -1,
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides access to a specific rundown by ID.
|
||||||
|
*
|
||||||
|
* Without an ID we do not yet know which rundown is loaded, so we bootstrap via
|
||||||
|
* the `/current` alias to keep the first paint to a single round-trip, then seed
|
||||||
|
* the id-keyed cache that every other reader shares.
|
||||||
|
*/
|
||||||
|
export function useRundownById(rundownId: string | null | undefined) {
|
||||||
|
const queryClient = useQueryClient();
|
||||||
|
const id = rundownId ?? '';
|
||||||
|
const isBootstrap = id === '';
|
||||||
|
|
||||||
|
const { data, status, isError, refetch, isFetching } = useQuery<Rundown>({
|
||||||
|
queryKey: getRundownCacheKey(id),
|
||||||
|
queryFn: ({ signal }) => (isBootstrap ? fetchCurrentRundown({ signal }) : fetchRundown(id, { signal })),
|
||||||
|
placeholderData: (previousData, _previousQuery) => previousData,
|
||||||
|
refetchInterval: queryRefetchIntervalSlow,
|
||||||
|
});
|
||||||
|
|
||||||
|
// Seed the id-keyed cache when fetching via the bootstrap alias
|
||||||
|
useEffect(() => {
|
||||||
|
if (!data || !isBootstrap) return;
|
||||||
|
queryClient.setQueryData(getRundownQueryKey(data.id), data);
|
||||||
|
}, [data, isBootstrap, queryClient]);
|
||||||
|
|
||||||
|
// Once we have the ID, drop the temporary current cache.
|
||||||
|
// Only the reader which bootstrapped may do so, others are still relying on it.
|
||||||
|
const didBootstrap = useRef(isBootstrap);
|
||||||
|
useEffect(() => {
|
||||||
|
if (isBootstrap || !didBootstrap.current) return;
|
||||||
|
didBootstrap.current = false;
|
||||||
|
queryClient.removeQueries({ queryKey: CURRENT_RUNDOWN_QUERY_KEY, exact: true });
|
||||||
|
}, [isBootstrap, queryClient]);
|
||||||
|
|
||||||
|
return { data: data ?? cachedRundownPlaceholder, status, isError, refetch, isFetching };
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Builds a flat rundown from the order and entries fields
|
||||||
|
*/
|
||||||
|
export function flattenRundown(rundown: Rundown): OntimeEntry[] {
|
||||||
|
if (rundown.revision === -1) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
return rundown.flatOrder
|
||||||
|
.map((id) => rundown.entries[id])
|
||||||
|
.filter((entry): entry is OntimeEntry => entry !== undefined);
|
||||||
|
}
|
||||||
@@ -1,54 +0,0 @@
|
|||||||
import { EntryId, Rundown } from 'ontime-types';
|
|
||||||
import { useMemo } from 'react';
|
|
||||||
|
|
||||||
import { useSelectedEventId } from '../hooks/useSocket';
|
|
||||||
import { getFlatRundownMetadata, type ExtendedEntry } from '../utils/rundownMetadata';
|
|
||||||
import { useProjectRundowns } from './useProjectRundowns';
|
|
||||||
import { useRundownById } from './useRundown';
|
|
||||||
|
|
||||||
export type RundownSource = {
|
|
||||||
rundownId: string | null;
|
|
||||||
rundown: Rundown;
|
|
||||||
flatRundown: ExtendedEntry[];
|
|
||||||
status: string;
|
|
||||||
selectedEventId: EntryId | null;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Explicitly scoped rundown data for views that may operate on a non-loaded rundown.
|
|
||||||
*/
|
|
||||||
export function useScopedRundown(rundownId: string | null): RundownSource {
|
|
||||||
const { data: projectRundowns } = useProjectRundowns();
|
|
||||||
return useRundownSource(rundownId, projectRundowns.loaded || null);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Loaded-rundown source for views that must follow the active runtime rundown.
|
|
||||||
*/
|
|
||||||
export function useLoadedRundownSource(): RundownSource {
|
|
||||||
const { data: projectRundowns } = useProjectRundowns();
|
|
||||||
const loadedRundownId = projectRundowns.loaded || null;
|
|
||||||
return useRundownSource(loadedRundownId, loadedRundownId);
|
|
||||||
}
|
|
||||||
|
|
||||||
function useRundownSource(rundownId: string | null, loadedRundownId: string | null): RundownSource {
|
|
||||||
const isLoadedTarget = rundownId !== null && rundownId === loadedRundownId;
|
|
||||||
const runtimeSelectedEventId = useSelectedEventId();
|
|
||||||
const effectiveSelectedEventId = isLoadedTarget ? runtimeSelectedEventId : null;
|
|
||||||
const { data: rundown, status } = useRundownById(rundownId);
|
|
||||||
const flatRundown = useMemo(
|
|
||||||
() => getFlatRundownMetadata(rundown, effectiveSelectedEventId),
|
|
||||||
[effectiveSelectedEventId, rundown],
|
|
||||||
);
|
|
||||||
|
|
||||||
return useMemo(
|
|
||||||
() => ({
|
|
||||||
rundownId,
|
|
||||||
rundown,
|
|
||||||
flatRundown,
|
|
||||||
status,
|
|
||||||
selectedEventId: effectiveSelectedEventId,
|
|
||||||
}),
|
|
||||||
[effectiveSelectedEventId, flatRundown, rundown, rundownId, status],
|
|
||||||
);
|
|
||||||
}
|
|
||||||
+6
-6
@@ -1,13 +1,13 @@
|
|||||||
import {
|
import {
|
||||||
FOLLOW_LOADED_RUNDOWN_ID,
|
FOLLOW_LOADED_RUNDOWN_ID,
|
||||||
getCuesheetRundownStorageKey,
|
getRundownSelectionStorageKey,
|
||||||
resolveSelectedRundownId,
|
resolveSelectedRundownId,
|
||||||
} from '../useCuesheetRundownSelection';
|
} from '../useRundownSelection';
|
||||||
|
|
||||||
describe('useCuesheetRundownSelection helpers', () => {
|
describe('useRundownSelection helpers', () => {
|
||||||
it('builds a project-scoped storage key', () => {
|
it('builds a namespace and project scoped storage key', () => {
|
||||||
expect(getCuesheetRundownStorageKey('http://localhost:4001', 'My Project')).toBe(
|
expect(getRundownSelectionStorageKey('cuesheet', 'http://localhost:4001', 'My Project')).toBe(
|
||||||
'cuesheet-selected-rundown:http://localhost:4001:My Project',
|
'rundown-selection:cuesheet:http://localhost:4001:My Project',
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -8,7 +8,6 @@ import {
|
|||||||
OntimeGroup,
|
OntimeGroup,
|
||||||
OntimeMilestone,
|
OntimeMilestone,
|
||||||
PatchWithId,
|
PatchWithId,
|
||||||
ProjectRundownsList,
|
|
||||||
Rundown,
|
Rundown,
|
||||||
SupportedEntry,
|
SupportedEntry,
|
||||||
TimeField,
|
TimeField,
|
||||||
@@ -32,9 +31,10 @@ import {
|
|||||||
swapEventData,
|
swapEventData,
|
||||||
} from 'ontime-utils';
|
} from 'ontime-utils';
|
||||||
import { useCallback, useMemo } from 'react';
|
import { useCallback, useMemo } from 'react';
|
||||||
|
import isEqual from 'react-fast-compare';
|
||||||
|
|
||||||
import { moveDown, moveUp, orderEntries } from '../../features/rundown/rundown.utils';
|
import { moveDown, moveUp, orderEntries } from '../../features/rundown/rundown.utils';
|
||||||
import { CURRENT_RUNDOWN_QUERY_KEY, PROJECT_RUNDOWNS, getRundownQueryKey } from '../api/constants';
|
import { getRundownCacheKey } from '../api/constants';
|
||||||
import {
|
import {
|
||||||
ReorderEntry,
|
ReorderEntry,
|
||||||
deleteEntries,
|
deleteEntries,
|
||||||
@@ -52,6 +52,7 @@ import {
|
|||||||
requestFitGroupTarget,
|
requestFitGroupTarget,
|
||||||
} from '../api/rundown';
|
} from '../api/rundown';
|
||||||
import { logAxiosError } from '../api/utils';
|
import { logAxiosError } from '../api/utils';
|
||||||
|
import { useRundownScope } from '../context/RundownScopeContext';
|
||||||
import { useEditorSettings } from '../stores/editorSettings';
|
import { useEditorSettings } from '../stores/editorSettings';
|
||||||
|
|
||||||
export type EventOptions = Partial<{
|
export type EventOptions = Partial<{
|
||||||
@@ -64,22 +65,38 @@ export type EventOptions = Partial<{
|
|||||||
lastEventId: MaybeString;
|
lastEventId: MaybeString;
|
||||||
}>;
|
}>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Applies a patch the way the server does, revision included.
|
||||||
|
*
|
||||||
|
* An entry revision advances on every change to that entry, which makes it a
|
||||||
|
* cheap marker for whether an entry has moved on. The optimistic entry has to
|
||||||
|
* carry the revision the server will return, otherwise the two disagree and the
|
||||||
|
* refetch resolves to a different object for no reason.
|
||||||
|
* Mirrors applyPatchToEntry in the rundown service: delays carry no revision.
|
||||||
|
*/
|
||||||
|
function patchEntry(entry: OntimeEntry, patch: Partial<OntimeEntry>): OntimeEntry {
|
||||||
|
if (isOntimeEvent(entry) || isOntimeGroup(entry) || isOntimeMilestone(entry)) {
|
||||||
|
return { ...entry, ...patch, revision: entry.revision + 1 } as OntimeEntry;
|
||||||
|
}
|
||||||
|
return { ...entry, ...patch } as OntimeEntry;
|
||||||
|
}
|
||||||
|
|
||||||
type ClientInsertOptions = {
|
type ClientInsertOptions = {
|
||||||
after?: EntryId;
|
after?: EntryId;
|
||||||
before?: EntryId;
|
before?: EntryId;
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gather utilities for actions on entries in the loaded rundown.
|
* Gather utilities for actions on entries in the rundown of the enclosing scope.
|
||||||
*/
|
*/
|
||||||
export const useEntryActions = () => useEntryActionsForRundown(undefined);
|
export const useEntryActions = () => useEntryActionsForRundown(useRundownScope().rundownId);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gather utilities for actions on entries in an explicitly selected rundown.
|
* Gather utilities for actions on entries in an explicitly selected rundown.
|
||||||
*/
|
*/
|
||||||
export const useScopedEntryActions = (rundownId: string | null) => useEntryActionsForRundown(rundownId ?? '');
|
export const useScopedEntryActions = (rundownId: MaybeString) => useEntryActionsForRundown(rundownId ?? '');
|
||||||
|
|
||||||
function useEntryActionsForRundown(scopedRundownId: string | undefined) {
|
function useEntryActionsForRundown(scopedRundownId: string) {
|
||||||
const queryClient = useQueryClient();
|
const queryClient = useQueryClient();
|
||||||
const {
|
const {
|
||||||
linkPrevious,
|
linkPrevious,
|
||||||
@@ -93,12 +110,8 @@ function useEntryActionsForRundown(scopedRundownId: string | undefined) {
|
|||||||
} = useEditorSettings();
|
} = useEditorSettings();
|
||||||
|
|
||||||
const resolveCurrentRundownQueryKey = useCallback(() => {
|
const resolveCurrentRundownQueryKey = useCallback(() => {
|
||||||
if (scopedRundownId !== undefined) {
|
return getRundownCacheKey(scopedRundownId);
|
||||||
return getRundownQueryKey(scopedRundownId);
|
}, [scopedRundownId]);
|
||||||
}
|
|
||||||
const loadedRundownId = queryClient.getQueryData<ProjectRundownsList>(PROJECT_RUNDOWNS)?.loaded;
|
|
||||||
return loadedRundownId ? getRundownQueryKey(loadedRundownId) : CURRENT_RUNDOWN_QUERY_KEY;
|
|
||||||
}, [queryClient, scopedRundownId]);
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the currently loaded rundown
|
* Returns the currently loaded rundown
|
||||||
@@ -325,8 +338,10 @@ function useEntryActionsForRundown(scopedRundownId: string | undefined) {
|
|||||||
if (previousData && eventId) {
|
if (previousData && eventId) {
|
||||||
// optimistically update object
|
// optimistically update object
|
||||||
const newRundown = { ...previousData.entries };
|
const newRundown = { ...previousData.entries };
|
||||||
// @ts-expect-error -- we expect the events to be of same type
|
const previousEntry = newRundown[eventId];
|
||||||
newRundown[eventId] = { ...newRundown[eventId], ...newEvent };
|
if (previousEntry) {
|
||||||
|
newRundown[eventId] = patchEntry(previousEntry, newEvent);
|
||||||
|
}
|
||||||
queryClient.setQueryData<Rundown>(queryKey, {
|
queryClient.setQueryData<Rundown>(queryKey, {
|
||||||
id: previousData.id,
|
id: previousData.id,
|
||||||
title: previousData.title,
|
title: previousData.title,
|
||||||
@@ -340,6 +355,23 @@ function useEntryActionsForRundown(scopedRundownId: string | undefined) {
|
|||||||
// Return a context with the previous and new events
|
// Return a context with the previous and new events
|
||||||
return { previousData, newEvent, queryKey };
|
return { previousData, newEvent, queryKey };
|
||||||
},
|
},
|
||||||
|
// the server is the authority on the applied patch, it may normalise what we sent
|
||||||
|
onSuccess: (response, _variables, context) => {
|
||||||
|
const serverEntry = response.data;
|
||||||
|
if (!serverEntry || !context?.queryKey) return;
|
||||||
|
|
||||||
|
const cachedRundown = queryClient.getQueryData<Rundown>(context.queryKey);
|
||||||
|
if (!cachedRundown) return;
|
||||||
|
|
||||||
|
// our optimistic entry usually describes the change exactly, writing an
|
||||||
|
// identical entry would discard the cached reference for nothing
|
||||||
|
if (isEqual(cachedRundown.entries[serverEntry.id], serverEntry)) return;
|
||||||
|
|
||||||
|
queryClient.setQueryData<Rundown>(context.queryKey, {
|
||||||
|
...cachedRundown,
|
||||||
|
entries: { ...cachedRundown.entries, [serverEntry.id]: serverEntry },
|
||||||
|
});
|
||||||
|
},
|
||||||
// Mutation fails, rollback undoes optimist update
|
// Mutation fails, rollback undoes optimist update
|
||||||
onError: (_error, _newEvent, context) => {
|
onError: (_error, _newEvent, context) => {
|
||||||
if (context?.previousData && context?.queryKey) {
|
if (context?.previousData && context?.queryKey) {
|
||||||
@@ -512,10 +544,7 @@ function useEntryActionsForRundown(scopedRundownId: string | undefined) {
|
|||||||
if (Object.hasOwn(newRundown, eventId)) {
|
if (Object.hasOwn(newRundown, eventId)) {
|
||||||
const event = newRundown[eventId];
|
const event = newRundown[eventId];
|
||||||
if (isOntimeEvent(event)) {
|
if (isOntimeEvent(event)) {
|
||||||
newRundown[eventId] = {
|
newRundown[eventId] = patchEntry(event, data.data);
|
||||||
...event,
|
|
||||||
...data,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
+24
-7
@@ -2,14 +2,21 @@ import { useSessionStorage } from '@mantine/hooks';
|
|||||||
import { startTransition, useCallback, useMemo } from 'react';
|
import { startTransition, useCallback, useMemo } from 'react';
|
||||||
import { useNavigate } from 'react-router';
|
import { useNavigate } from 'react-router';
|
||||||
|
|
||||||
import { useOrderedProjectList } from '../../common/hooks-query/useProjectList';
|
|
||||||
import { useProjectRundowns } from '../../common/hooks-query/useProjectRundowns';
|
|
||||||
import { serverURL } from '../../externals';
|
import { serverURL } from '../../externals';
|
||||||
|
import { useOrderedProjectList } from '../hooks-query/useProjectList';
|
||||||
|
import { useProjectRundowns } from '../hooks-query/useProjectRundowns';
|
||||||
|
|
||||||
export const FOLLOW_LOADED_RUNDOWN_ID = '__follow-loaded__' as const;
|
export const FOLLOW_LOADED_RUNDOWN_ID = '__follow-loaded__' as const;
|
||||||
|
|
||||||
export function getCuesheetRundownStorageKey(server: string, projectFilename: string) {
|
/** each surface keeps its own selection, so panels can point at different rundowns */
|
||||||
return `cuesheet-selected-rundown:${server}:${projectFilename}`;
|
export type RundownSelectionNamespace = 'cuesheet';
|
||||||
|
|
||||||
|
export function getRundownSelectionStorageKey(
|
||||||
|
namespace: RundownSelectionNamespace,
|
||||||
|
server: string,
|
||||||
|
projectFilename: string,
|
||||||
|
) {
|
||||||
|
return `rundown-selection:${namespace}:${server}:${projectFilename}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
export function resolveSelectedRundownId(storedSelectedRundownId: string | null, availableRundownIds: Set<string>) {
|
export function resolveSelectedRundownId(storedSelectedRundownId: string | null, availableRundownIds: Set<string>) {
|
||||||
@@ -17,14 +24,22 @@ export function resolveSelectedRundownId(storedSelectedRundownId: string | null,
|
|||||||
return FOLLOW_LOADED_RUNDOWN_ID;
|
return FOLLOW_LOADED_RUNDOWN_ID;
|
||||||
}
|
}
|
||||||
|
|
||||||
export function useCuesheetRundownSelection() {
|
/**
|
||||||
|
* Persisted choice of which rundown a surface operates on.
|
||||||
|
* The resolved id is meant to be handed to a rundown scope provider,
|
||||||
|
* where null means follow whichever rundown is loaded.
|
||||||
|
*/
|
||||||
|
export function useRundownSelection(namespace: RundownSelectionNamespace) {
|
||||||
'use memo';
|
'use memo';
|
||||||
|
|
||||||
const { data: projectRundowns } = useProjectRundowns();
|
const { data: projectRundowns } = useProjectRundowns();
|
||||||
const {
|
const {
|
||||||
data: { lastLoadedProject },
|
data: { lastLoadedProject },
|
||||||
} = useOrderedProjectList();
|
} = useOrderedProjectList();
|
||||||
const storageKey = useMemo(() => getCuesheetRundownStorageKey(serverURL, lastLoadedProject), [lastLoadedProject]);
|
const storageKey = useMemo(
|
||||||
|
() => getRundownSelectionStorageKey(namespace, serverURL, lastLoadedProject),
|
||||||
|
[namespace, lastLoadedProject],
|
||||||
|
);
|
||||||
const [storedSelectedRundownId, setStoredSelectedRundownId] = useSessionStorage<string | null>({
|
const [storedSelectedRundownId, setStoredSelectedRundownId] = useSessionStorage<string | null>({
|
||||||
key: storageKey,
|
key: storageKey,
|
||||||
defaultValue: FOLLOW_LOADED_RUNDOWN_ID,
|
defaultValue: FOLLOW_LOADED_RUNDOWN_ID,
|
||||||
@@ -38,6 +53,8 @@ export function useCuesheetRundownSelection() {
|
|||||||
return {
|
return {
|
||||||
loadedRundownId,
|
loadedRundownId,
|
||||||
selectedRundownId,
|
selectedRundownId,
|
||||||
|
/** id for the rundown scope, null follows the loaded rundown */
|
||||||
|
scopedRundownId: selectedRundownId === FOLLOW_LOADED_RUNDOWN_ID ? null : selectedRundownId,
|
||||||
projectRundowns: projectRundowns.rundowns,
|
projectRundowns: projectRundowns.rundowns,
|
||||||
setSelectedRundownId: (rundownId: string) => {
|
setSelectedRundownId: (rundownId: string) => {
|
||||||
startTransition(() => {
|
startTransition(() => {
|
||||||
@@ -52,7 +69,7 @@ export function useDirectLinkToBackgroundEdit() {
|
|||||||
data: { lastLoadedProject },
|
data: { lastLoadedProject },
|
||||||
} = useOrderedProjectList();
|
} = useOrderedProjectList();
|
||||||
const navigate = useNavigate();
|
const navigate = useNavigate();
|
||||||
const storageKey = getCuesheetRundownStorageKey(serverURL, lastLoadedProject);
|
const storageKey = getRundownSelectionStorageKey('cuesheet', serverURL, lastLoadedProject);
|
||||||
const [_, setStoredSelectedRundownId] = useSessionStorage<string | null>({ key: storageKey, defaultValue: null });
|
const [_, setStoredSelectedRundownId] = useSessionStorage<string | null>({ key: storageKey, defaultValue: null });
|
||||||
|
|
||||||
return useCallback(
|
return useCallback(
|
||||||
@@ -0,0 +1,64 @@
|
|||||||
|
import { Rundown, SupportedEntry } from 'ontime-types';
|
||||||
|
|
||||||
|
import { createEventSelectionStore } from '../eventSelectionStore';
|
||||||
|
|
||||||
|
function makeRundown(id: string, eventIds: string[]): Rundown {
|
||||||
|
return {
|
||||||
|
id,
|
||||||
|
title: id,
|
||||||
|
order: eventIds,
|
||||||
|
flatOrder: eventIds,
|
||||||
|
entries: Object.fromEntries(eventIds.map((entryId) => [entryId, { id: entryId, type: SupportedEntry.Event }])),
|
||||||
|
revision: 1,
|
||||||
|
} as unknown as Rundown;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('createEventSelectionStore', () => {
|
||||||
|
it('keeps selections of separate instances independent', () => {
|
||||||
|
const first = createEventSelectionStore(() => makeRundown('rundown-a', ['a1', 'a2']));
|
||||||
|
const second = createEventSelectionStore(() => makeRundown('rundown-b', ['b1', 'b2']));
|
||||||
|
|
||||||
|
first.getState().setSingleEntrySelection({ id: 'a1' });
|
||||||
|
second.getState().setSingleEntrySelection({ id: 'b2' });
|
||||||
|
|
||||||
|
expect(first.getState().cursor).toBe('a1');
|
||||||
|
expect(second.getState().cursor).toBe('b2');
|
||||||
|
expect(first.getState().selectedEvents).toEqual(new Set(['a1']));
|
||||||
|
expect(second.getState().selectedEvents).toEqual(new Set(['b2']));
|
||||||
|
});
|
||||||
|
|
||||||
|
it('resolves a shift range against the injected rundown', () => {
|
||||||
|
const store = createEventSelectionStore(() => makeRundown('rundown-a', ['a1', 'a2', 'a3']));
|
||||||
|
|
||||||
|
store.getState().setSelectedEvents({ id: 'a3', index: 2, selectMode: 'shift' });
|
||||||
|
|
||||||
|
// without an anchor the range runs from the top up to the clicked index
|
||||||
|
expect(store.getState().selectedEvents).toEqual(new Set(['a1', 'a2']));
|
||||||
|
expect(store.getState().anchoredIndex).toBe(2);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('replaces the selection set so subscribers on the set re-render', () => {
|
||||||
|
const store = createEventSelectionStore(() => makeRundown('rundown-a', ['a1', 'a2']));
|
||||||
|
|
||||||
|
store.getState().setSelectedEvents({ id: 'a1', index: 0, selectMode: 'click' });
|
||||||
|
const afterClick = store.getState().selectedEvents;
|
||||||
|
|
||||||
|
store.getState().setSelectedEvents({ id: 'a2', index: 1, selectMode: 'ctrl' });
|
||||||
|
const afterAdd = store.getState().selectedEvents;
|
||||||
|
expect(afterAdd).not.toBe(afterClick);
|
||||||
|
expect(afterAdd).toEqual(new Set(['a1', 'a2']));
|
||||||
|
|
||||||
|
store.getState().unselect('a1');
|
||||||
|
const afterUnselect = store.getState().selectedEvents;
|
||||||
|
expect(afterUnselect).not.toBe(afterAdd);
|
||||||
|
expect(afterUnselect).toEqual(new Set(['a2']));
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not select when the rundown is unavailable', () => {
|
||||||
|
const store = createEventSelectionStore(() => undefined);
|
||||||
|
|
||||||
|
store.getState().setSelectedEvents({ id: 'a1', index: 0, selectMode: 'shift' });
|
||||||
|
|
||||||
|
expect(store.getState().selectedEvents).toEqual(new Set());
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,14 +1,21 @@
|
|||||||
|
import { MaybeString } from 'ontime-types';
|
||||||
import { create } from 'zustand';
|
import { create } from 'zustand';
|
||||||
|
|
||||||
type EntryCopyStore = {
|
type EntryCopyStore = {
|
||||||
entryCopyId: string | null;
|
entryCopyId: MaybeString;
|
||||||
|
/** rundown the copied entry belongs to, so a paste knows whether it crosses rundowns */
|
||||||
|
entryCopyRundownId: MaybeString;
|
||||||
entryCopyMode: 'copy' | 'cut';
|
entryCopyMode: 'copy' | 'cut';
|
||||||
setEntryCopyId: (eventId: string | null, mode?: 'copy' | 'cut') => void;
|
setEntryCopyId: (eventId: MaybeString, rundownId: MaybeString, mode?: 'copy' | 'cut') => void;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The clipboard is shared across rundowns so entries can be moved between them
|
||||||
|
*/
|
||||||
export const useEntryCopy = create<EntryCopyStore>()((set) => ({
|
export const useEntryCopy = create<EntryCopyStore>()((set) => ({
|
||||||
entryCopyId: null,
|
entryCopyId: null,
|
||||||
|
entryCopyRundownId: null,
|
||||||
entryCopyMode: 'copy',
|
entryCopyMode: 'copy',
|
||||||
setEntryCopyId: (entryCopyId: string | null, mode: 'copy' | 'cut' = 'copy') =>
|
setEntryCopyId: (entryCopyId: MaybeString, entryCopyRundownId: MaybeString, mode: 'copy' | 'cut' = 'copy') =>
|
||||||
set({ entryCopyId, entryCopyMode: mode }),
|
set({ entryCopyId, entryCopyRundownId, entryCopyMode: mode }),
|
||||||
}));
|
}));
|
||||||
|
|||||||
@@ -0,0 +1,158 @@
|
|||||||
|
import { EntryId, MaybeNumber, Rundown, isOntimeEvent } from 'ontime-types';
|
||||||
|
import { MouseEvent } from 'react';
|
||||||
|
import { StoreApi } from 'zustand';
|
||||||
|
import { createStore } from 'zustand/vanilla';
|
||||||
|
|
||||||
|
import { isMacOS } from '../utils/deviceUtils';
|
||||||
|
|
||||||
|
export type SelectionMode = 'shift' | 'click' | 'ctrl';
|
||||||
|
|
||||||
|
export interface EventSelectionStore {
|
||||||
|
selectedEvents: Set<EntryId>;
|
||||||
|
anchoredIndex: MaybeNumber;
|
||||||
|
cursor: EntryId | null;
|
||||||
|
entryMode: 'event' | 'single' | null;
|
||||||
|
scrollHandler: ((id: EntryId) => void) | null;
|
||||||
|
setSingleEntrySelection: (selectionArgs: { id: EntryId }) => void;
|
||||||
|
setSelectedEvents: (selectionArgs: { id: EntryId; index: number; selectMode: SelectionMode }) => void;
|
||||||
|
clearSelectedEvents: () => void;
|
||||||
|
clearMultiSelect: () => void;
|
||||||
|
unselect: (id: EntryId) => void;
|
||||||
|
setScrollHandler: (handler: ((id: EntryId) => void) | null) => void;
|
||||||
|
scrollToEntry: (id: EntryId) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type EventSelectionStoreApi = StoreApi<EventSelectionStore>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Keeps track of the selected entries and selection mode
|
||||||
|
* Provides methods to update the selection based on user interactions
|
||||||
|
*
|
||||||
|
* One store instance exists per rundown scope, so panels showing different
|
||||||
|
* rundowns keep independent selections. The rundown the selection refers to is
|
||||||
|
* injected as `getRundown` rather than resolved from the loaded rundown.
|
||||||
|
*/
|
||||||
|
export function createEventSelectionStore(getRundown: () => Rundown | undefined): EventSelectionStoreApi {
|
||||||
|
return createStore<EventSelectionStore>()((set, get) => ({
|
||||||
|
selectedEvents: new Set(),
|
||||||
|
anchoredIndex: null,
|
||||||
|
cursor: null,
|
||||||
|
entryMode: null,
|
||||||
|
scrollHandler: null,
|
||||||
|
setSingleEntrySelection: ({ id }) => {
|
||||||
|
set({ selectedEvents: new Set([id]), anchoredIndex: null, cursor: id, entryMode: 'single' });
|
||||||
|
},
|
||||||
|
setSelectedEvents: ({ id, index, selectMode }) => {
|
||||||
|
const { selectedEvents, anchoredIndex, entryMode } = get();
|
||||||
|
|
||||||
|
// if we are in single mode, we replace the selection and change the mode
|
||||||
|
if (entryMode === 'single') {
|
||||||
|
return set({ selectedEvents: new Set([id]), anchoredIndex: index, cursor: id, entryMode: 'event' });
|
||||||
|
}
|
||||||
|
|
||||||
|
// on click, we replace selection with event
|
||||||
|
if (selectMode === 'click') {
|
||||||
|
return set({ selectedEvents: new Set([id]), anchoredIndex: index, cursor: id, entryMode: 'event' });
|
||||||
|
}
|
||||||
|
|
||||||
|
// on ctrl + click, we toggle the selection of that event
|
||||||
|
if (selectMode === 'ctrl') {
|
||||||
|
const rundownData = getRundown();
|
||||||
|
if (!rundownData) return;
|
||||||
|
|
||||||
|
// if it doesnt exist, simply add to the list and set an anchor
|
||||||
|
if (!selectedEvents.has(id)) {
|
||||||
|
return set({
|
||||||
|
selectedEvents: new Set(selectedEvents).add(id),
|
||||||
|
anchoredIndex: index,
|
||||||
|
cursor: id,
|
||||||
|
entryMode: 'event',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// if event is already selected, we remove it from selection
|
||||||
|
// and set the anchor to the event after
|
||||||
|
const withoutId = new Set(selectedEvents);
|
||||||
|
withoutId.delete(id);
|
||||||
|
|
||||||
|
const nextIndex = rundownData.order.findIndex(
|
||||||
|
(eventId, i) => i > index && isOntimeEvent(rundownData.entries[eventId]) && withoutId.has(eventId),
|
||||||
|
);
|
||||||
|
|
||||||
|
// if we didnt find anything after, set the anchor to the last event
|
||||||
|
return set({
|
||||||
|
selectedEvents: withoutId,
|
||||||
|
anchoredIndex: nextIndex < 0 ? rundownData.order.length - 1 : nextIndex,
|
||||||
|
entryMode: 'event',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// on shift + click, we select a range of events up to the clicked event
|
||||||
|
if (selectMode === 'shift') {
|
||||||
|
const rundownData = getRundown();
|
||||||
|
if (!rundownData) return;
|
||||||
|
|
||||||
|
// get list of rundown with only ontime events
|
||||||
|
const eventIds: EntryId[] = [];
|
||||||
|
rundownData.flatOrder.forEach((eventId) => {
|
||||||
|
const event = rundownData.entries[eventId];
|
||||||
|
if (isOntimeEvent(event)) {
|
||||||
|
eventIds.push(event.id);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const start = anchoredIndex === null ? 0 : Math.min(anchoredIndex, index);
|
||||||
|
const end = anchoredIndex === null ? index : Math.max(anchoredIndex, index + 1);
|
||||||
|
|
||||||
|
// create new set with range of ids from start to end
|
||||||
|
const selectedEventIds = eventIds.slice(start, end);
|
||||||
|
|
||||||
|
return set({
|
||||||
|
selectedEvents: new Set([...selectedEvents, ...selectedEventIds]),
|
||||||
|
anchoredIndex: index,
|
||||||
|
entryMode: 'event',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
},
|
||||||
|
clearSelectedEvents: () => set({ selectedEvents: new Set(), anchoredIndex: null, cursor: null, entryMode: null }),
|
||||||
|
clearMultiSelect: () => {
|
||||||
|
const { selectedEvents } = get();
|
||||||
|
const [firstSelected] = selectedEvents;
|
||||||
|
set({
|
||||||
|
selectedEvents: new Set(firstSelected ? [firstSelected] : []),
|
||||||
|
anchoredIndex: null,
|
||||||
|
entryMode: null,
|
||||||
|
});
|
||||||
|
},
|
||||||
|
unselect: (id: string) => {
|
||||||
|
const { entryMode, selectedEvents } = get();
|
||||||
|
const remaining = new Set(selectedEvents);
|
||||||
|
remaining.delete(id);
|
||||||
|
set({
|
||||||
|
selectedEvents: remaining,
|
||||||
|
entryMode: remaining.size === 0 ? null : entryMode,
|
||||||
|
});
|
||||||
|
},
|
||||||
|
// Sets the scroll handler for programmatic scrolling to entries
|
||||||
|
setScrollHandler: (handler) => set({ scrollHandler: handler }),
|
||||||
|
// Scrolls to the specified entry using the registered scroll handler
|
||||||
|
scrollToEntry: (id: EntryId) => {
|
||||||
|
const handler = get().scrollHandler;
|
||||||
|
if (handler) {
|
||||||
|
handler(id);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getSelectionMode(event: MouseEvent): SelectionMode {
|
||||||
|
if ((isMacOS() && event.metaKey) || event.ctrlKey) {
|
||||||
|
return 'ctrl';
|
||||||
|
}
|
||||||
|
|
||||||
|
if (event.shiftKey) {
|
||||||
|
return 'shift';
|
||||||
|
}
|
||||||
|
|
||||||
|
return 'click';
|
||||||
|
}
|
||||||
@@ -242,12 +242,12 @@ export function maybeInvalidateRundownCache(revision: MaybeNumber, rundownId?: s
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
// skip if we dont recognise the ID the revision is lower
|
|
||||||
const queryKey = getRundownQueryKey(rundownId);
|
const queryKey = getRundownQueryKey(rundownId);
|
||||||
const cachedRundown = ontimeQueryClient.getQueryData<{ revision: number }>(queryKey);
|
const cachedRundown = ontimeQueryClient.getQueryData<{ revision: number }>(queryKey);
|
||||||
|
|
||||||
if (revision === cachedRundown?.revision) {
|
// we already have this change, or something newer
|
||||||
// we already have the latest change
|
// messages can arrive after a refetch has already brought in a later revision
|
||||||
|
if (revision !== null && cachedRundown !== undefined && revision <= cachedRundown.revision) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -4,8 +4,8 @@ import { IoTrashBin } from 'react-icons/io5';
|
|||||||
import { deleteAllReport } from '../../../../common/api/report';
|
import { deleteAllReport } from '../../../../common/api/report';
|
||||||
import { createBlob, downloadBlob } from '../../../../common/api/utils';
|
import { createBlob, downloadBlob } from '../../../../common/api/utils';
|
||||||
import Button from '../../../../common/components/buttons/Button';
|
import Button from '../../../../common/components/buttons/Button';
|
||||||
|
import { useLoadedRundown } from '../../../../common/hooks-query/useLoadedRundown';
|
||||||
import useReport from '../../../../common/hooks-query/useReport';
|
import useReport from '../../../../common/hooks-query/useReport';
|
||||||
import useRundown from '../../../../common/hooks-query/useRundown';
|
|
||||||
import { cx } from '../../../../common/utils/styleUtils';
|
import { cx } from '../../../../common/utils/styleUtils';
|
||||||
import { formatTime } from '../../../../common/utils/time';
|
import { formatTime } from '../../../../common/utils/time';
|
||||||
import * as Panel from '../../panel-utils/PanelUtils';
|
import * as Panel from '../../panel-utils/PanelUtils';
|
||||||
@@ -15,7 +15,7 @@ import style from './ReportSettings.module.scss';
|
|||||||
|
|
||||||
export default function ReportSettings() {
|
export default function ReportSettings() {
|
||||||
const { data: reportData } = useReport();
|
const { data: reportData } = useReport();
|
||||||
const { data } = useRundown();
|
const { data } = useLoadedRundown();
|
||||||
|
|
||||||
const clearReport = async () => await deleteAllReport();
|
const clearReport = async () => await deleteAllReport();
|
||||||
const downloadCSV = (combinedReport: CombinedReport[]) => {
|
const downloadCSV = (combinedReport: CombinedReport[]) => {
|
||||||
|
|||||||
@@ -19,8 +19,8 @@ import Dialog from '../../../../common/components/dialog/Dialog';
|
|||||||
import { DropdownMenu } from '../../../../common/components/dropdown-menu/DropdownMenu';
|
import { DropdownMenu } from '../../../../common/components/dropdown-menu/DropdownMenu';
|
||||||
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 { useDirectLinkToBackgroundEdit } from '../../../../common/hooks/useRundownSelection';
|
||||||
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';
|
||||||
|
|||||||
+2
-2
@@ -24,7 +24,7 @@ import Button from '../../../../../common/components/buttons/Button';
|
|||||||
import Info from '../../../../../common/components/info/Info';
|
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 { useLoadedRundown } from '../../../../../common/hooks-query/useLoadedRundown';
|
||||||
import { removeFileExtension, 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';
|
||||||
@@ -59,7 +59,7 @@ export default function SourcesPanel() {
|
|||||||
const [activeSource, setActiveSource] = useState<ActiveSource | null>(null);
|
const [activeSource, setActiveSource] = useState<ActiveSource | null>(null);
|
||||||
const [completedRundownTitle, setCompletedRundownTitle] = useState('');
|
const [completedRundownTitle, setCompletedRundownTitle] = useState('');
|
||||||
|
|
||||||
const { data: currentRundown } = useRundown();
|
const { data: currentRundown } = useLoadedRundown();
|
||||||
const { applyImport } = useSpreadsheetImport();
|
const { applyImport } = useSpreadsheetImport();
|
||||||
const navigate = useNavigate();
|
const navigate = useNavigate();
|
||||||
|
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ import { useCallback, useState } from 'react';
|
|||||||
import { IoClose } from 'react-icons/io5';
|
import { IoClose } from 'react-icons/io5';
|
||||||
|
|
||||||
import Button from '../../common/components/buttons/Button';
|
import Button from '../../common/components/buttons/Button';
|
||||||
|
import ToggleButton from '../../common/components/buttons/ToggleButton';
|
||||||
import { clearLogs, useLogData } from '../../common/stores/logger';
|
import { clearLogs, useLogData } from '../../common/stores/logger';
|
||||||
import { cx } from '../../common/utils/styleUtils';
|
import { cx } from '../../common/utils/styleUtils';
|
||||||
import * as Panel from '../app-settings/panel-utils/PanelUtils';
|
import * as Panel from '../app-settings/panel-utils/PanelUtils';
|
||||||
@@ -55,72 +56,60 @@ export default function Log() {
|
|||||||
<div className={cx([style.container, isExtracted && style.extracted])}>
|
<div className={cx([style.container, isExtracted && style.extracted])}>
|
||||||
<Panel.InlineElements className={style.buttonBar}>
|
<Panel.InlineElements className={style.buttonBar}>
|
||||||
<span className={style.filterLabel}>Filter by</span>
|
<span className={style.filterLabel}>Filter by</span>
|
||||||
<Button
|
<ToggleButton
|
||||||
variant={showUser ? 'primary' : 'subtle'}
|
pressed={showUser}
|
||||||
size='small'
|
size='small'
|
||||||
aria-pressed={showUser}
|
|
||||||
aria-label={`${showUser ? 'Hide' : 'Show'} ${LogOrigin.User} events`}
|
|
||||||
onClick={() => setShowUser((s) => !s)}
|
onClick={() => setShowUser((s) => !s)}
|
||||||
onAuxClick={() => disableOthers(LogOrigin.User)}
|
onAuxClick={() => disableOthers(LogOrigin.User)}
|
||||||
onContextMenu={(e) => e.preventDefault()}
|
onContextMenu={(e) => e.preventDefault()}
|
||||||
>
|
>
|
||||||
{LogOrigin.User}
|
{LogOrigin.User}
|
||||||
</Button>
|
</ToggleButton>
|
||||||
<Button
|
<ToggleButton
|
||||||
variant={showClient ? 'primary' : 'subtle'}
|
pressed={showClient}
|
||||||
size='small'
|
size='small'
|
||||||
aria-pressed={showClient}
|
|
||||||
aria-label={`${showClient ? 'Hide' : 'Show'} ${LogOrigin.Client} events`}
|
|
||||||
onClick={() => setShowClient((s) => !s)}
|
onClick={() => setShowClient((s) => !s)}
|
||||||
onAuxClick={() => disableOthers(LogOrigin.Client)}
|
onAuxClick={() => disableOthers(LogOrigin.Client)}
|
||||||
onContextMenu={(e) => e.preventDefault()}
|
onContextMenu={(e) => e.preventDefault()}
|
||||||
>
|
>
|
||||||
{LogOrigin.Client}
|
{LogOrigin.Client}
|
||||||
</Button>
|
</ToggleButton>
|
||||||
<Button
|
<ToggleButton
|
||||||
variant={showServer ? 'primary' : 'subtle'}
|
pressed={showServer}
|
||||||
size='small'
|
size='small'
|
||||||
aria-pressed={showServer}
|
|
||||||
aria-label={`${showServer ? 'Hide' : 'Show'} ${LogOrigin.Server} events`}
|
|
||||||
onClick={() => setShowServer((s) => !s)}
|
onClick={() => setShowServer((s) => !s)}
|
||||||
onAuxClick={() => disableOthers(LogOrigin.Server)}
|
onAuxClick={() => disableOthers(LogOrigin.Server)}
|
||||||
onContextMenu={(e) => e.preventDefault()}
|
onContextMenu={(e) => e.preventDefault()}
|
||||||
>
|
>
|
||||||
{LogOrigin.Server}
|
{LogOrigin.Server}
|
||||||
</Button>
|
</ToggleButton>
|
||||||
<Button
|
<ToggleButton
|
||||||
variant={showPlayback ? 'primary' : 'subtle'}
|
pressed={showPlayback}
|
||||||
size='small'
|
size='small'
|
||||||
aria-pressed={showPlayback}
|
|
||||||
aria-label={`${showPlayback ? 'Hide' : 'Show'} ${LogOrigin.Playback} events`}
|
|
||||||
onClick={() => setShowPlayback((s) => !s)}
|
onClick={() => setShowPlayback((s) => !s)}
|
||||||
onAuxClick={() => disableOthers(LogOrigin.Playback)}
|
onAuxClick={() => disableOthers(LogOrigin.Playback)}
|
||||||
onContextMenu={(e) => e.preventDefault()}
|
onContextMenu={(e) => e.preventDefault()}
|
||||||
>
|
>
|
||||||
{LogOrigin.Playback}
|
{LogOrigin.Playback}
|
||||||
</Button>
|
</ToggleButton>
|
||||||
<Button
|
<ToggleButton
|
||||||
variant={showRx ? 'primary' : 'subtle'}
|
pressed={showRx}
|
||||||
size='small'
|
size='small'
|
||||||
aria-pressed={showRx}
|
|
||||||
aria-label={`${showRx ? 'Hide' : 'Show'} ${LogOrigin.Rx} events`}
|
|
||||||
onClick={() => setShowRx((s) => !s)}
|
onClick={() => setShowRx((s) => !s)}
|
||||||
onAuxClick={() => disableOthers(LogOrigin.Rx)}
|
onAuxClick={() => disableOthers(LogOrigin.Rx)}
|
||||||
onContextMenu={(e) => e.preventDefault()}
|
onContextMenu={(e) => e.preventDefault()}
|
||||||
>
|
>
|
||||||
{LogOrigin.Rx}
|
{LogOrigin.Rx}
|
||||||
</Button>
|
</ToggleButton>
|
||||||
<Button
|
<ToggleButton
|
||||||
variant={showTx ? 'primary' : 'subtle'}
|
pressed={showTx}
|
||||||
size='small'
|
size='small'
|
||||||
aria-pressed={showTx}
|
|
||||||
aria-label={`${showTx ? 'Hide' : 'Show'} ${LogOrigin.Tx} events`}
|
|
||||||
onClick={() => setShowTx((s) => !s)}
|
onClick={() => setShowTx((s) => !s)}
|
||||||
onAuxClick={() => disableOthers(LogOrigin.Tx)}
|
onAuxClick={() => disableOthers(LogOrigin.Tx)}
|
||||||
onContextMenu={(e) => e.preventDefault()}
|
onContextMenu={(e) => e.preventDefault()}
|
||||||
>
|
>
|
||||||
{LogOrigin.Tx}
|
{LogOrigin.Tx}
|
||||||
</Button>
|
</ToggleButton>
|
||||||
<Button variant='subtle-destructive' size='small' onClick={clearLogs} className={style.apart}>
|
<Button variant='subtle-destructive' size='small' onClick={clearLogs} className={style.apart}>
|
||||||
<IoClose /> Clear
|
<IoClose /> Clear
|
||||||
</Button>
|
</Button>
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
import { CustomFields, Rundown, Settings } from 'ontime-types';
|
import { CustomFields, Rundown, Settings } from 'ontime-types';
|
||||||
|
|
||||||
import useCustomFields from '../../common/hooks-query/useCustomFields';
|
import useCustomFields from '../../common/hooks-query/useCustomFields';
|
||||||
import { useRundownWithMetadata } from '../../common/hooks-query/useRundown';
|
import { useLoadedRundownWithMetadata } from '../../common/hooks-query/useLoadedRundown';
|
||||||
import useSettings from '../../common/hooks-query/useSettings';
|
import useSettings from '../../common/hooks-query/useSettings';
|
||||||
import { RundownMetadataObject } from '../../common/utils/rundownMetadata';
|
import { RundownMetadataObject } from '../../common/utils/rundownMetadata';
|
||||||
import { ViewData, aggregateQueryStatus } from '../../views/utils/viewLoader.utils';
|
import { ViewData, aggregateQueryStatus } from '../../views/utils/viewLoader.utils';
|
||||||
@@ -14,7 +14,7 @@ export interface OperatorData {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export function useOperatorData(): ViewData<OperatorData> {
|
export function useOperatorData(): ViewData<OperatorData> {
|
||||||
const { data: rundown, rundownMetadata, status: rundownStatus } = useRundownWithMetadata();
|
const { data: rundown, rundownMetadata, status: rundownStatus } = useLoadedRundownWithMetadata();
|
||||||
const { data: customFields, status: customFieldStatus } = useCustomFields();
|
const { data: customFields, status: customFieldStatus } = useCustomFields();
|
||||||
const { data: settings, status: settingsStatus } = useSettings();
|
const { data: settings, status: settingsStatus } = useSettings();
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ import {
|
|||||||
} from 'react-icons/tb';
|
} from 'react-icons/tb';
|
||||||
|
|
||||||
import Tooltip from '../../../common/components/tooltip/Tooltip';
|
import Tooltip from '../../../common/components/tooltip/Tooltip';
|
||||||
import { useEntry } from '../../../common/hooks-query/useRundown';
|
import { useLoadedEntry } from '../../../common/hooks-query/useLoadedRundown';
|
||||||
import { useAutoTickingClock } from '../../../common/hooks/useAutoTickingClock';
|
import { useAutoTickingClock } from '../../../common/hooks/useAutoTickingClock';
|
||||||
import {
|
import {
|
||||||
useCurrentGroupId,
|
useCurrentGroupId,
|
||||||
@@ -210,7 +210,7 @@ export function MetadataTimes() {
|
|||||||
function GroupTimes() {
|
function GroupTimes() {
|
||||||
const { clock, mode, groupExpectedEnd, actualGroupStart, currentDay, playback, phase } = useGroupTimerOverView();
|
const { clock, mode, groupExpectedEnd, actualGroupStart, currentDay, playback, phase } = useGroupTimerOverView();
|
||||||
const currentGroupId = useCurrentGroupId();
|
const currentGroupId = useCurrentGroupId();
|
||||||
const group = useEntry(currentGroupId) as OntimeGroup | null;
|
const group = useLoadedEntry(currentGroupId) as OntimeGroup | null;
|
||||||
|
|
||||||
const hasRunningTimer = phase !== TimerPhase.Pending && isPlaybackActive(playback);
|
const hasRunningTimer = phase !== TimerPhase.Pending && isPlaybackActive(playback);
|
||||||
|
|
||||||
@@ -266,7 +266,7 @@ function GroupTimes() {
|
|||||||
function FlagTimes() {
|
function FlagTimes() {
|
||||||
const { clock, mode, actualStart, plannedStart, playback, currentDay, phase } = useFlagTimerOverView();
|
const { clock, mode, actualStart, plannedStart, playback, currentDay, phase } = useFlagTimerOverView();
|
||||||
const { id, expectedStart } = useNextFlag();
|
const { id, expectedStart } = useNextFlag();
|
||||||
const entry = useEntry(id) as OntimeEvent | null;
|
const entry = useLoadedEntry(id) as OntimeEvent | null;
|
||||||
|
|
||||||
const hasRunningTimer = phase !== TimerPhase.Pending && isPlaybackActive(playback);
|
const hasRunningTimer = phase !== TimerPhase.Pending && isPlaybackActive(playback);
|
||||||
|
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
|
import { useLoadedRundownAuxData } from '../../../common/hooks-query/useLoadedRundown';
|
||||||
import useProjectData from '../../../common/hooks-query/useProjectData';
|
import useProjectData from '../../../common/hooks-query/useProjectData';
|
||||||
import { useRundownAuxData } from '../../../common/hooks-query/useRundown';
|
|
||||||
|
|
||||||
import style from './TitleOverview.module.scss';
|
import style from './TitleOverview.module.scss';
|
||||||
|
|
||||||
export default function TitleOverview() {
|
export default function TitleOverview() {
|
||||||
'use memo';
|
'use memo';
|
||||||
const { data: projectData } = useProjectData();
|
const { data: projectData } = useProjectData();
|
||||||
const { data: rundownData } = useRundownAuxData();
|
const { data: rundownData } = useLoadedRundownAuxData();
|
||||||
|
|
||||||
const projectTitle = projectData.title.trim();
|
const projectTitle = projectData.title.trim();
|
||||||
const rundownTitle = rundownData.title.trim();
|
const rundownTitle = rundownData.title.trim();
|
||||||
|
|||||||
@@ -67,7 +67,11 @@ export default function Rundown({ order, flatOrder, entries, id, rundownMetadata
|
|||||||
const { getIsCollapsed, collapseGroup, expandGroup } = useCollapsedGroups(id);
|
const { getIsCollapsed, collapseGroup, expandGroup } = useCollapsedGroups(id);
|
||||||
|
|
||||||
const entryActions = useEntryActionsContext();
|
const entryActions = useEntryActionsContext();
|
||||||
const setEntryCopyId = useEntryCopy((state) => state.setEntryCopyId);
|
const setEntryCopy = useEntryCopy((state) => state.setEntryCopyId);
|
||||||
|
const setEntryCopyId = useCallback(
|
||||||
|
(entryId: EntryId | null, mode?: 'copy' | 'cut') => setEntryCopy(entryId, id, mode),
|
||||||
|
[setEntryCopy, id],
|
||||||
|
);
|
||||||
|
|
||||||
// cursor
|
// cursor
|
||||||
const { editorMode } = useEditorFollowMode();
|
const { editorMode } = useEditorFollowMode();
|
||||||
|
|||||||
@@ -5,9 +5,6 @@ import * as Editor from '../../common/components/editor-utils/EditorUtils';
|
|||||||
import ErrorBoundary from '../../common/components/error-boundary/ErrorBoundary';
|
import ErrorBoundary from '../../common/components/error-boundary/ErrorBoundary';
|
||||||
import ViewNavigationMenu from '../../common/components/navigation-menu/ViewNavigationMenu';
|
import ViewNavigationMenu from '../../common/components/navigation-menu/ViewNavigationMenu';
|
||||||
import ProtectRoute from '../../common/components/protect-route/ProtectRoute';
|
import ProtectRoute from '../../common/components/protect-route/ProtectRoute';
|
||||||
import { EntryActionsProvider } from '../../common/context/EntryActionsContext';
|
|
||||||
import { useLoadedRundownSource } from '../../common/hooks-query/useScopedRundown';
|
|
||||||
import { useEntryActions } from '../../common/hooks/useEntryAction';
|
|
||||||
import { useIsSmallDevice } from '../../common/hooks/useIsSmallDevice';
|
import { useIsSmallDevice } from '../../common/hooks/useIsSmallDevice';
|
||||||
import { handleLinks } from '../../common/utils/linkUtils';
|
import { handleLinks } from '../../common/utils/linkUtils';
|
||||||
import { cx } from '../../common/utils/styleUtils';
|
import { cx } from '../../common/utils/styleUtils';
|
||||||
@@ -39,28 +36,25 @@ function RundownExport() {
|
|||||||
defaultValue: RundownViewMode.List,
|
defaultValue: RundownViewMode.List,
|
||||||
});
|
});
|
||||||
const isSmallDevice = useIsSmallDevice();
|
const isSmallDevice = useIsSmallDevice();
|
||||||
const entryActions = useEntryActions();
|
|
||||||
|
|
||||||
if (isSmallDevice && isExtracted) {
|
if (isSmallDevice && isExtracted) {
|
||||||
return (
|
return (
|
||||||
<EntryActionsProvider actions={entryActions}>
|
<ProtectRoute permission='editor'>
|
||||||
<ProtectRoute permission='editor'>
|
<div
|
||||||
<div
|
className={cx([style.rundownExport, style.extracted])}
|
||||||
className={cx([style.rundownExport, style.extracted])}
|
data-target='small-device'
|
||||||
data-target='small-device'
|
data-testid='panel-rundown'
|
||||||
data-testid='panel-rundown'
|
>
|
||||||
>
|
<FinderPlacement />
|
||||||
<FinderPlacement />
|
<ViewNavigationMenu suppressSettings />
|
||||||
<ViewNavigationMenu suppressSettings />
|
<div className={style.rundown}>
|
||||||
<div className={style.rundown}>
|
<ErrorBoundary>
|
||||||
<ErrorBoundary>
|
<RundownRoot isSmallDevice isExtracted viewMode={viewMode} setViewMode={setViewMode} />
|
||||||
<RundownRoot isSmallDevice isExtracted viewMode={viewMode} setViewMode={setViewMode} />
|
<RundownContextMenu />
|
||||||
<RundownContextMenu />
|
</ErrorBoundary>
|
||||||
</ErrorBoundary>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
</ProtectRoute>
|
</div>
|
||||||
</EntryActionsProvider>
|
</ProtectRoute>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -70,30 +64,28 @@ function RundownExport() {
|
|||||||
viewMode === RundownViewMode.Table;
|
viewMode === RundownViewMode.Table;
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<EntryActionsProvider actions={entryActions}>
|
<ProtectRoute permission='editor'>
|
||||||
<ProtectRoute permission='editor'>
|
<div className={cx([style.rundownExport, isExtracted && style.extracted])} data-testid='panel-rundown'>
|
||||||
<div className={cx([style.rundownExport, isExtracted && style.extracted])} data-testid='panel-rundown'>
|
<FinderPlacement />
|
||||||
<FinderPlacement />
|
{isExtracted && <ViewNavigationMenu suppressSettings isNavigationLocked={getIsNavigationLocked()} />}
|
||||||
{isExtracted && <ViewNavigationMenu suppressSettings isNavigationLocked={getIsNavigationLocked()} />}
|
<div className={style.rundown}>
|
||||||
<div className={style.rundown}>
|
<Editor.Panel className={style.list}>
|
||||||
<Editor.Panel className={style.list}>
|
<ErrorBoundary>
|
||||||
|
{!isExtracted && <Editor.CornerExtract onClick={(event) => handleLinks('rundown', event)} />}
|
||||||
|
<RundownRoot isExtracted={isExtracted} viewMode={viewMode} setViewMode={setViewMode} />
|
||||||
|
<RundownContextMenu />
|
||||||
|
</ErrorBoundary>
|
||||||
|
</Editor.Panel>
|
||||||
|
{!hideSideBar && (
|
||||||
|
<div className={style.side}>
|
||||||
<ErrorBoundary>
|
<ErrorBoundary>
|
||||||
{!isExtracted && <Editor.CornerExtract onClick={(event) => handleLinks('rundown', event)} />}
|
<RundownEntryEditor />
|
||||||
<RundownRoot isExtracted={isExtracted} viewMode={viewMode} setViewMode={setViewMode} />
|
|
||||||
<RundownContextMenu />
|
|
||||||
</ErrorBoundary>
|
</ErrorBoundary>
|
||||||
</Editor.Panel>
|
</div>
|
||||||
{!hideSideBar && (
|
)}
|
||||||
<div className={style.side}>
|
|
||||||
<ErrorBoundary>
|
|
||||||
<RundownEntryEditor />
|
|
||||||
</ErrorBoundary>
|
|
||||||
</div>
|
|
||||||
)}
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
</ProtectRoute>
|
</div>
|
||||||
</EntryActionsProvider>
|
</ProtectRoute>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -105,8 +97,6 @@ interface RundownRootProps {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function RundownRoot({ isSmallDevice, isExtracted, viewMode, setViewMode }: RundownRootProps) {
|
function RundownRoot({ isSmallDevice, isExtracted, viewMode, setViewMode }: RundownRootProps) {
|
||||||
const source = useLoadedRundownSource();
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className={style.rundownRoot}>
|
<div className={style.rundownRoot}>
|
||||||
{isSmallDevice ? (
|
{isSmallDevice ? (
|
||||||
@@ -115,7 +105,7 @@ function RundownRoot({ isSmallDevice, isExtracted, viewMode, setViewMode }: Rund
|
|||||||
<RundownHeader isExtracted={isExtracted} viewMode={viewMode} setViewMode={setViewMode} />
|
<RundownHeader isExtracted={isExtracted} viewMode={viewMode} setViewMode={setViewMode} />
|
||||||
)}
|
)}
|
||||||
{viewMode === RundownViewMode.List ? <RundownList /> : <RundownTable />}
|
{viewMode === RundownViewMode.List ? <RundownList /> : <RundownTable />}
|
||||||
{viewMode === RundownViewMode.Table && <EntryEditModal rundown={source.rundown} />}
|
{viewMode === RundownViewMode.Table && <EntryEditModal />}
|
||||||
<RenumberCuesDialog />
|
<RenumberCuesDialog />
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -1,15 +1,22 @@
|
|||||||
|
import { Playback } from 'ontime-types';
|
||||||
import { memo } from 'react';
|
import { memo } from 'react';
|
||||||
|
|
||||||
import EmptyFill from '../../common/components/state/EmptyFill';
|
import EmptyFill from '../../common/components/state/EmptyFill';
|
||||||
|
import { useRundownScope } from '../../common/context/RundownScopeContext';
|
||||||
import { useRundownWithMetadata } from '../../common/hooks-query/useRundown';
|
import { useRundownWithMetadata } from '../../common/hooks-query/useRundown';
|
||||||
import { useRundownEditor } from '../../common/hooks/useSocket';
|
import { useRundownEditor } from '../../common/hooks/useSocket';
|
||||||
import { useTranslation } from '../../translation/TranslationProvider';
|
import { useTranslation } from '../../translation/TranslationProvider';
|
||||||
import Rundown from './Rundown';
|
import Rundown from './Rundown';
|
||||||
|
|
||||||
|
/** a rundown which is not loaded has no playback to follow */
|
||||||
|
const idleFeatureData = { playback: Playback.Stop, selectedEventId: null, nextEventId: null };
|
||||||
|
|
||||||
export default memo(RundownList);
|
export default memo(RundownList);
|
||||||
function RundownList() {
|
function RundownList() {
|
||||||
|
const { isLoaded } = useRundownScope();
|
||||||
const { data, status, rundownMetadata } = useRundownWithMetadata();
|
const { data, status, rundownMetadata } = useRundownWithMetadata();
|
||||||
const featureData = useRundownEditor();
|
const runtimeFeatureData = useRundownEditor();
|
||||||
|
const featureData = isLoaded ? runtimeFeatureData : idleFeatureData;
|
||||||
const { getLocalizedString } = useTranslation();
|
const { getLocalizedString } = useTranslation();
|
||||||
|
|
||||||
// avoid showing the editable empty state before we know whether the rundown is actually empty
|
// avoid showing the editable empty state before we know whether the rundown is actually empty
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ import { type EntryId, type OntimeEntry, type Rundown, SupportedEntry } from 'on
|
|||||||
import { getNextGroupNormal, getNextNormal, getPreviousGroupNormal, getPreviousNormal } from 'ontime-utils';
|
import { getNextGroupNormal, getNextNormal, getPreviousGroupNormal, getPreviousNormal } from 'ontime-utils';
|
||||||
import { useCallback } from 'react';
|
import { useCallback } from 'react';
|
||||||
|
|
||||||
|
import { useRundownScope } from '../../../common/context/RundownScopeContext';
|
||||||
import type { useEntryActions } from '../../../common/hooks/useEntryAction';
|
import type { useEntryActions } from '../../../common/hooks/useEntryAction';
|
||||||
import { useEntryCopy } from '../../../common/stores/entryCopyStore';
|
import { useEntryCopy } from '../../../common/stores/entryCopyStore';
|
||||||
import { SelectionMode } from '../useEventSelection';
|
import { SelectionMode } from '../useEventSelection';
|
||||||
@@ -26,6 +27,7 @@ export function useRundownCommands({
|
|||||||
selectEntry: applySelection,
|
selectEntry: applySelection,
|
||||||
handleCollapseGroup,
|
handleCollapseGroup,
|
||||||
}: UseRundownCommandsOptions) {
|
}: UseRundownCommandsOptions) {
|
||||||
|
const { rundownId } = useRundownScope();
|
||||||
const { addEntry, clone, deleteEntry, move, reorderEntry } = entryActions;
|
const { addEntry, clone, deleteEntry, move, reorderEntry } = entryActions;
|
||||||
|
|
||||||
const deleteAtCursor = useCallback(
|
const deleteAtCursor = useCallback(
|
||||||
@@ -43,12 +45,17 @@ export function useRundownCommands({
|
|||||||
const insertCopyAtId = useCallback(
|
const insertCopyAtId = useCallback(
|
||||||
(atId: EntryId | null, above = false) => {
|
(atId: EntryId | null, above = false) => {
|
||||||
// lazily get the value from the store
|
// lazily get the value from the store
|
||||||
const { entryCopyId, entryCopyMode, setEntryCopyId } = useEntryCopy.getState();
|
const { entryCopyId, entryCopyRundownId, entryCopyMode, setEntryCopyId } = useEntryCopy.getState();
|
||||||
if (entryCopyId === null || !entries[entryCopyId]) {
|
if (entryCopyId === null || !entries[entryCopyId]) {
|
||||||
// we cant clone without selection
|
// we cant clone without selection
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// pasting into a different rundown needs the entry payload, the server clones within a rundown
|
||||||
|
if (entryCopyRundownId !== null && entryCopyRundownId !== rundownId) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
let normalisedAtId = atId;
|
let normalisedAtId = atId;
|
||||||
|
|
||||||
const elementToCopy = entries[entryCopyId];
|
const elementToCopy = entries[entryCopyId];
|
||||||
@@ -65,7 +72,7 @@ export function useRundownCommands({
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
reorderEntry(entryCopyId, firstId, 'before')
|
reorderEntry(entryCopyId, firstId, 'before')
|
||||||
.then(() => setEntryCopyId(null))
|
.then(() => setEntryCopyId(null, null))
|
||||||
.catch(() => {});
|
.catch(() => {});
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
@@ -74,7 +81,7 @@ export function useRundownCommands({
|
|||||||
}
|
}
|
||||||
const placement = above ? 'before' : 'after';
|
const placement = above ? 'before' : 'after';
|
||||||
reorderEntry(entryCopyId, normalisedAtId, placement)
|
reorderEntry(entryCopyId, normalisedAtId, placement)
|
||||||
.then(() => setEntryCopyId(null))
|
.then(() => setEntryCopyId(null, null))
|
||||||
.catch(() => {});
|
.catch(() => {});
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
@@ -85,7 +92,7 @@ export function useRundownCommands({
|
|||||||
before: above ? (normalisedAtId ?? undefined) : undefined,
|
before: above ? (normalisedAtId ?? undefined) : undefined,
|
||||||
});
|
});
|
||||||
},
|
},
|
||||||
[entries, flatOrder, clone, reorderEntry],
|
[entries, flatOrder, clone, reorderEntry, rundownId],
|
||||||
);
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -8,10 +8,16 @@ export default memo(FinderPlacement);
|
|||||||
function FinderPlacement() {
|
function FinderPlacement() {
|
||||||
const [isOpen, handler] = useDisclosure();
|
const [isOpen, handler] = useDisclosure();
|
||||||
|
|
||||||
useHotkeys([
|
/**
|
||||||
['mod + f', handler.toggle, { preventDefault: true }],
|
* The empty tagsToIgnore is significant: by default the hook skips input elements,
|
||||||
['Escape', handler.close, { preventDefault: true }],
|
* which would make the shortcut dead while editing an entry.
|
||||||
]);
|
*
|
||||||
|
* This opens rather than toggles. Toggling on a key that also mounts and unmounts the
|
||||||
|
* dialog races against it, and browsers treat a repeated find shortcut as "focus the
|
||||||
|
* search again" rather than "close it". The finder selects its input instead, and
|
||||||
|
* Escape closes.
|
||||||
|
*/
|
||||||
|
useHotkeys([['mod + f', handler.open, { preventDefault: true }]], []);
|
||||||
|
|
||||||
if (isOpen) {
|
if (isOpen) {
|
||||||
return <Finder isOpen={isOpen} onClose={handler.close} />;
|
return <Finder isOpen={isOpen} onClose={handler.close} />;
|
||||||
|
|||||||
@@ -312,6 +312,7 @@ export default function RundownEvent({
|
|||||||
onClick={handleFocusClick}
|
onClick={handleFocusClick}
|
||||||
onContextMenu={onContextMenu}
|
onContextMenu={onContextMenu}
|
||||||
data-testid='rundown-event'
|
data-testid='rundown-event'
|
||||||
|
data-selected={isSelected}
|
||||||
{...(isPlaying ? { 'data-running': true } : {})}
|
{...(isPlaying ? { 'data-running': true } : {})}
|
||||||
>
|
>
|
||||||
<RundownIndicators timeStart={timeStart} delay={delay} gap={gap} isNextDay={isNextDay} />
|
<RundownIndicators timeStart={timeStart} delay={delay} gap={gap} isNextDay={isNextDay} />
|
||||||
|
|||||||
@@ -1,9 +1,6 @@
|
|||||||
import { memo, useEffect, useMemo } from 'react';
|
import { memo, useEffect, useMemo } from 'react';
|
||||||
|
|
||||||
import { EntryActionsProvider } from '../../../common/context/EntryActionsContext';
|
|
||||||
import useCustomFields from '../../../common/hooks-query/useCustomFields';
|
import useCustomFields from '../../../common/hooks-query/useCustomFields';
|
||||||
import { useLoadedRundownSource } from '../../../common/hooks-query/useScopedRundown';
|
|
||||||
import { useEntryActions } from '../../../common/hooks/useEntryAction';
|
|
||||||
import CuesheetDnd from '../../../views/cuesheet/cuesheet-dnd/CuesheetDnd';
|
import CuesheetDnd from '../../../views/cuesheet/cuesheet-dnd/CuesheetDnd';
|
||||||
import CuesheetTable from '../../../views/cuesheet/cuesheet-table/CuesheetTable';
|
import CuesheetTable from '../../../views/cuesheet/cuesheet-table/CuesheetTable';
|
||||||
import { useCuesheetPermissions } from '../../../views/cuesheet/useTablePermissions';
|
import { useCuesheetPermissions } from '../../../views/cuesheet/useTablePermissions';
|
||||||
@@ -15,8 +12,6 @@ function RundownTable() {
|
|||||||
const { data: customFields } = useCustomFields();
|
const { data: customFields } = useCustomFields();
|
||||||
const setPermissions = useCuesheetPermissions((state) => state.setPermissions);
|
const setPermissions = useCuesheetPermissions((state) => state.setPermissions);
|
||||||
const { editorMode } = useEditorFollowMode();
|
const { editorMode } = useEditorFollowMode();
|
||||||
const source = useLoadedRundownSource();
|
|
||||||
const actions = useEntryActions();
|
|
||||||
|
|
||||||
// Editor always has full permissions
|
// Editor always has full permissions
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
@@ -32,10 +27,8 @@ function RundownTable() {
|
|||||||
const columns = useMemo(() => makeRundownColumns(customFields), [customFields]);
|
const columns = useMemo(() => makeRundownColumns(customFields), [customFields]);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<EntryActionsProvider actions={actions}>
|
<CuesheetDnd columns={columns} tableRoot='editor'>
|
||||||
<CuesheetDnd columns={columns} tableRoot='editor'>
|
<CuesheetTable columns={columns} cuesheetMode={editorMode} tableRoot='editor' />
|
||||||
<CuesheetTable columns={columns} source={source} cuesheetMode={editorMode} tableRoot='editor' />
|
</CuesheetDnd>
|
||||||
</CuesheetDnd>
|
|
||||||
</EntryActionsProvider>
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,155 +1,15 @@
|
|||||||
import { EntryId, MaybeNumber, ProjectRundownsList, Rundown, isOntimeEvent } from 'ontime-types';
|
import { useStore } from 'zustand';
|
||||||
import { MouseEvent } from 'react';
|
|
||||||
import { create } from 'zustand';
|
|
||||||
|
|
||||||
import { PROJECT_RUNDOWNS, getRundownQueryKey } from '../../common/api/constants';
|
import { useRundownScope } from '../../common/context/RundownScopeContext';
|
||||||
import { ontimeQueryClient } from '../../common/queryClient';
|
import type { EventSelectionStore } from '../../common/stores/eventSelectionStore';
|
||||||
import { isMacOS } from '../../common/utils/deviceUtils';
|
|
||||||
|
|
||||||
export type SelectionMode = 'shift' | 'click' | 'ctrl';
|
export { getSelectionMode } from '../../common/stores/eventSelectionStore';
|
||||||
|
export type { SelectionMode } from '../../common/stores/eventSelectionStore';
|
||||||
interface EventSelectionStore {
|
|
||||||
selectedEvents: Set<EntryId>;
|
|
||||||
anchoredIndex: MaybeNumber;
|
|
||||||
cursor: EntryId | null;
|
|
||||||
entryMode: 'event' | 'single' | null;
|
|
||||||
scrollHandler: ((id: EntryId) => void) | null;
|
|
||||||
setSingleEntrySelection: (selectionArgs: { id: EntryId }) => void;
|
|
||||||
setSelectedEvents: (selectionArgs: { id: EntryId; index: number; selectMode: SelectionMode }) => void;
|
|
||||||
clearSelectedEvents: () => void;
|
|
||||||
clearMultiSelect: () => void;
|
|
||||||
unselect: (id: EntryId) => void;
|
|
||||||
setScrollHandler: (handler: ((id: EntryId) => void) | null) => void;
|
|
||||||
scrollToEntry: (id: EntryId) => void;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Keeps track of the selected entries and selection mode
|
* Selection and cursor for the rundown of the enclosing scope
|
||||||
* Provides methods to update the selection based on user interactions
|
|
||||||
*/
|
*/
|
||||||
export const useEventSelection = create<EventSelectionStore>()((set, get) => ({
|
export function useEventSelection<T>(selector: (state: EventSelectionStore) => T): T {
|
||||||
selectedEvents: new Set(),
|
const { selectionStore } = useRundownScope();
|
||||||
anchoredIndex: null,
|
return useStore(selectionStore, selector);
|
||||||
cursor: null,
|
|
||||||
entryMode: null,
|
|
||||||
scrollHandler: null,
|
|
||||||
setSingleEntrySelection: ({ id }) => {
|
|
||||||
set({ selectedEvents: new Set([id]), anchoredIndex: null, cursor: id, entryMode: 'single' });
|
|
||||||
},
|
|
||||||
setSelectedEvents: ({ id, index, selectMode }) => {
|
|
||||||
const { selectedEvents, anchoredIndex, entryMode } = get();
|
|
||||||
|
|
||||||
// if we are in single mode, we replace the selection and change the mode
|
|
||||||
if (entryMode === 'single') {
|
|
||||||
return set({ selectedEvents: new Set([id]), anchoredIndex: index, cursor: id, entryMode: 'event' });
|
|
||||||
}
|
|
||||||
|
|
||||||
// on click, we replace selection with event
|
|
||||||
if (selectMode === 'click') {
|
|
||||||
return set({ selectedEvents: new Set([id]), anchoredIndex: index, cursor: id, entryMode: 'event' });
|
|
||||||
}
|
|
||||||
|
|
||||||
// on ctrl + click, we toggle the selection of that event
|
|
||||||
if (selectMode === 'ctrl') {
|
|
||||||
const rundownData = getLoadedRundownData();
|
|
||||||
if (!rundownData) return;
|
|
||||||
|
|
||||||
// if it doesnt exist, simply add to the list and set an anchor
|
|
||||||
if (!selectedEvents.has(id)) {
|
|
||||||
return set({
|
|
||||||
selectedEvents: selectedEvents.add(id),
|
|
||||||
anchoredIndex: index,
|
|
||||||
cursor: id,
|
|
||||||
entryMode: 'event',
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// if event is already selected, we remove it from selection
|
|
||||||
// and set the anchor to the event after
|
|
||||||
selectedEvents.delete(id);
|
|
||||||
|
|
||||||
const nextIndex = rundownData.order.findIndex(
|
|
||||||
(eventId, i) => i > index && isOntimeEvent(rundownData.entries[eventId]) && selectedEvents.has(eventId),
|
|
||||||
);
|
|
||||||
|
|
||||||
// if we didnt find anything after, set the anchor to the last event
|
|
||||||
return set({
|
|
||||||
selectedEvents,
|
|
||||||
anchoredIndex: nextIndex < 0 ? rundownData.order.length - 1 : nextIndex,
|
|
||||||
entryMode: 'event',
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// on shift + click, we select a range of events up to the clicked event
|
|
||||||
if (selectMode === 'shift') {
|
|
||||||
const rundownData = getLoadedRundownData();
|
|
||||||
if (!rundownData) return;
|
|
||||||
|
|
||||||
// get list of rundown with only ontime events
|
|
||||||
const eventIds: EntryId[] = [];
|
|
||||||
rundownData.flatOrder.forEach((eventId) => {
|
|
||||||
const event = rundownData.entries[eventId];
|
|
||||||
if (isOntimeEvent(event)) {
|
|
||||||
eventIds.push(event.id);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
const start = anchoredIndex === null ? 0 : Math.min(anchoredIndex, index);
|
|
||||||
const end = anchoredIndex === null ? index : Math.max(anchoredIndex, index + 1);
|
|
||||||
|
|
||||||
// create new set with range of ids from start to end
|
|
||||||
const selectedEventIds = eventIds.slice(start, end);
|
|
||||||
|
|
||||||
return set({
|
|
||||||
selectedEvents: new Set([...selectedEvents, ...selectedEventIds]),
|
|
||||||
anchoredIndex: index,
|
|
||||||
entryMode: 'event',
|
|
||||||
});
|
|
||||||
}
|
|
||||||
},
|
|
||||||
clearSelectedEvents: () => set({ selectedEvents: new Set(), anchoredIndex: null, cursor: null, entryMode: null }),
|
|
||||||
clearMultiSelect: () => {
|
|
||||||
const { selectedEvents } = get();
|
|
||||||
const [firstSelected] = selectedEvents;
|
|
||||||
set({
|
|
||||||
selectedEvents: new Set(firstSelected ? [firstSelected] : []),
|
|
||||||
anchoredIndex: null,
|
|
||||||
entryMode: null,
|
|
||||||
});
|
|
||||||
},
|
|
||||||
unselect: (id: string) => {
|
|
||||||
const { entryMode, selectedEvents } = get();
|
|
||||||
selectedEvents.delete(id);
|
|
||||||
set({
|
|
||||||
selectedEvents,
|
|
||||||
entryMode: selectedEvents.size === 0 ? null : entryMode,
|
|
||||||
});
|
|
||||||
},
|
|
||||||
// Sets the scroll handler for programmatic scrolling to entries
|
|
||||||
setScrollHandler: (handler) => set({ scrollHandler: handler }),
|
|
||||||
// Scrolls to the specified entry using the registered scroll handler
|
|
||||||
scrollToEntry: (id: EntryId) => {
|
|
||||||
const handler = get().scrollHandler;
|
|
||||||
if (handler) {
|
|
||||||
handler(id);
|
|
||||||
}
|
|
||||||
},
|
|
||||||
}));
|
|
||||||
|
|
||||||
function getLoadedRundownData() {
|
|
||||||
const rundownId = ontimeQueryClient.getQueryData<ProjectRundownsList>(PROJECT_RUNDOWNS)?.loaded;
|
|
||||||
if (!rundownId) return undefined;
|
|
||||||
return ontimeQueryClient.getQueryData<Rundown>(getRundownQueryKey(rundownId));
|
|
||||||
}
|
|
||||||
|
|
||||||
export function getSelectionMode(event: MouseEvent): SelectionMode {
|
|
||||||
if ((isMacOS() && event.metaKey) || event.ctrlKey) {
|
|
||||||
return 'ctrl';
|
|
||||||
}
|
|
||||||
|
|
||||||
if (event.shiftKey) {
|
|
||||||
return 'shift';
|
|
||||||
}
|
|
||||||
|
|
||||||
return 'click';
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
import { EntryId, MaybeString } from 'ontime-types';
|
import { EntryId, MaybeString } from 'ontime-types';
|
||||||
import { useCallback } from 'react';
|
import { useCallback } from 'react';
|
||||||
|
|
||||||
|
import { useRundownScope } from '../../common/context/RundownScopeContext';
|
||||||
import { useCollapsedGroups } from './useCollapsedGroups';
|
import { useCollapsedGroups } from './useCollapsedGroups';
|
||||||
import { useEventSelection } from './useEventSelection';
|
import { useEventSelection } from './useEventSelection';
|
||||||
|
|
||||||
@@ -10,7 +11,8 @@ type SelectAndRevealOptions = {
|
|||||||
parent?: MaybeString;
|
parent?: MaybeString;
|
||||||
};
|
};
|
||||||
|
|
||||||
export function useSelectAndRevealEntry(rundownId: string) {
|
export function useSelectAndRevealEntry() {
|
||||||
|
const { rundownId } = useRundownScope();
|
||||||
const { expandGroup } = useCollapsedGroups(rundownId);
|
const { expandGroup } = useCollapsedGroups(rundownId);
|
||||||
const selectEntry = useEventSelection((state) => state.setSelectedEvents);
|
const selectEntry = useEventSelection((state) => state.setSelectedEvents);
|
||||||
const scrollToEntry = useEventSelection((state) => state.scrollToEntry);
|
const scrollToEntry = useEventSelection((state) => state.scrollToEntry);
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
import { CustomFields, OntimeEntry, ProjectData, Settings } from 'ontime-types';
|
import { CustomFields, OntimeEntry, ProjectData, Settings } from 'ontime-types';
|
||||||
|
|
||||||
import useCustomFields from '../../common/hooks-query/useCustomFields';
|
import useCustomFields from '../../common/hooks-query/useCustomFields';
|
||||||
|
import { useLoadedFlatRundown } from '../../common/hooks-query/useLoadedRundown';
|
||||||
import useProjectData from '../../common/hooks-query/useProjectData';
|
import useProjectData from '../../common/hooks-query/useProjectData';
|
||||||
import { useFlatRundown } from '../../common/hooks-query/useRundown';
|
|
||||||
import useSettings from '../../common/hooks-query/useSettings';
|
import useSettings from '../../common/hooks-query/useSettings';
|
||||||
import { useViewOptionsStore } from '../../common/stores/viewOptions';
|
import { useViewOptionsStore } from '../../common/stores/viewOptions';
|
||||||
import { ViewData, aggregateQueryStatus } from '../utils/viewLoader.utils';
|
import { ViewData, aggregateQueryStatus } from '../utils/viewLoader.utils';
|
||||||
@@ -20,7 +20,7 @@ export function useBackstageData(): ViewData<BackstageData> {
|
|||||||
const isMirrored = useViewOptionsStore((state) => state.mirror);
|
const isMirrored = useViewOptionsStore((state) => state.mirror);
|
||||||
|
|
||||||
// HTTP API data
|
// HTTP API data
|
||||||
const { data: rundownData, status: rundownStatus } = useFlatRundown();
|
const { data: rundownData, status: rundownStatus } = useLoadedFlatRundown();
|
||||||
const { data: projectData, status: projectDataStatus } = useProjectData();
|
const { data: projectData, status: projectDataStatus } = useProjectData();
|
||||||
const { data: settings, status: settingsStatus } = useSettings();
|
const { data: settings, status: settingsStatus } = useSettings();
|
||||||
const { data: customFields, status: customFieldsStatus } = useCustomFields();
|
const { data: customFields, status: customFieldsStatus } = useCustomFields();
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ import {
|
|||||||
useState,
|
useState,
|
||||||
} from 'react';
|
} from 'react';
|
||||||
|
|
||||||
import { usePartialRundown } from '../../../common/hooks-query/useRundown';
|
import { useLoadedPartialRundown } from '../../../common/hooks-query/useLoadedRundown';
|
||||||
import { ExtendedEntry } from '../../../common/utils/rundownMetadata';
|
import { ExtendedEntry } from '../../../common/utils/rundownMetadata';
|
||||||
import { useScheduleOptions } from './schedule.options';
|
import { useScheduleOptions } from './schedule.options';
|
||||||
|
|
||||||
@@ -45,7 +45,7 @@ export const ScheduleProvider = ({ children, selectedEventId }: PropsWithChildre
|
|||||||
[filter],
|
[filter],
|
||||||
);
|
);
|
||||||
|
|
||||||
const { data: events } = usePartialRundown(filterCallback);
|
const { data: events } = useLoadedPartialRundown(filterCallback);
|
||||||
|
|
||||||
const [firstIndex, setFirstIndex] = useState(-1);
|
const [firstIndex, setFirstIndex] = useState(-1);
|
||||||
const [numPages, setNumPages] = useState(0);
|
const [numPages, setNumPages] = useState(0);
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
import { CustomFields, OntimeEntry, ProjectData, Settings } from 'ontime-types';
|
import { CustomFields, OntimeEntry, ProjectData, Settings } from 'ontime-types';
|
||||||
|
|
||||||
import useCustomFields from '../../common/hooks-query/useCustomFields';
|
import useCustomFields from '../../common/hooks-query/useCustomFields';
|
||||||
|
import { useLoadedFlatRundownWithMetadata } from '../../common/hooks-query/useLoadedRundown';
|
||||||
import useProjectData from '../../common/hooks-query/useProjectData';
|
import useProjectData from '../../common/hooks-query/useProjectData';
|
||||||
import { useFlatRundownWithMetadata } from '../../common/hooks-query/useRundown';
|
|
||||||
import useSettings from '../../common/hooks-query/useSettings';
|
import useSettings from '../../common/hooks-query/useSettings';
|
||||||
import { useViewOptionsStore } from '../../common/stores/viewOptions';
|
import { useViewOptionsStore } from '../../common/stores/viewOptions';
|
||||||
import { ExtendedEntry } from '../../common/utils/rundownMetadata';
|
import { ExtendedEntry } from '../../common/utils/rundownMetadata';
|
||||||
@@ -21,7 +21,7 @@ export function useCountdownData(): ViewData<CountdownData> {
|
|||||||
const isMirrored = useViewOptionsStore((state) => state.mirror);
|
const isMirrored = useViewOptionsStore((state) => state.mirror);
|
||||||
|
|
||||||
// HTTP API data
|
// HTTP API data
|
||||||
const { data: rundownData, status: rundownStatus } = useFlatRundownWithMetadata();
|
const { data: rundownData, status: rundownStatus } = useLoadedFlatRundownWithMetadata();
|
||||||
const { data: projectData, status: projectDataStatus } = useProjectData();
|
const { data: projectData, status: projectDataStatus } = useProjectData();
|
||||||
const { data: settings, status: settingsStatus } = useSettings();
|
const { data: settings, status: settingsStatus } = useSettings();
|
||||||
const { data: customFields, status: customFieldsStatus } = useCustomFields();
|
const { data: customFields, status: customFieldsStatus } = useCustomFields();
|
||||||
|
|||||||
@@ -3,35 +3,31 @@ import { IoApps } from 'react-icons/io5';
|
|||||||
|
|
||||||
import IconButton from '../../common/components/buttons/IconButton';
|
import IconButton from '../../common/components/buttons/IconButton';
|
||||||
import NavigationMenu from '../../common/components/navigation-menu/NavigationMenu';
|
import NavigationMenu from '../../common/components/navigation-menu/NavigationMenu';
|
||||||
import { EntryActionsProvider } from '../../common/context/EntryActionsContext';
|
import { EditableRundownScopeProvider } from '../../common/context/EditableRundownScopeProvider';
|
||||||
import { useScopedRundown } from '../../common/hooks-query/useScopedRundown';
|
import { useRundownSelection } from '../../common/hooks/useRundownSelection';
|
||||||
import { useScopedEntryActions } from '../../common/hooks/useEntryAction';
|
|
||||||
import { useWindowTitle } from '../../common/hooks/useWindowTitle';
|
import { useWindowTitle } from '../../common/hooks/useWindowTitle';
|
||||||
import { getIsNavigationLocked } from '../../externals';
|
import { getIsNavigationLocked } from '../../externals';
|
||||||
import CuesheetOverview from '../../features/overview/CuesheetOverview';
|
import CuesheetOverview from '../../features/overview/CuesheetOverview';
|
||||||
import EntryEditModal from './cuesheet-edit-modal/EntryEditModal';
|
import EntryEditModal from './cuesheet-edit-modal/EntryEditModal';
|
||||||
import CuesheetProgress from './cuesheet-progress/CuesheetProgress';
|
import CuesheetProgress from './cuesheet-progress/CuesheetProgress';
|
||||||
import CuesheetTableWrapper from './CuesheetTableWrapper';
|
import CuesheetTableWrapper from './CuesheetTableWrapper';
|
||||||
import { FOLLOW_LOADED_RUNDOWN_ID, useCuesheetRundownSelection } from './useCuesheetRundownSelection';
|
|
||||||
|
|
||||||
import styles from './CuesheetPage.module.scss';
|
import styles from './CuesheetPage.module.scss';
|
||||||
|
|
||||||
export default function CuesheetPage() {
|
export default function CuesheetPage() {
|
||||||
'use memo';
|
'use memo';
|
||||||
const [isMenuOpen, menuHandler] = useDisclosure();
|
const [isMenuOpen, menuHandler] = useDisclosure();
|
||||||
const { selectedRundownId, loadedRundownId, setSelectedRundownId, projectRundowns } = useCuesheetRundownSelection();
|
const { scopedRundownId, selectedRundownId, loadedRundownId, setSelectedRundownId, projectRundowns } =
|
||||||
const source = useScopedRundown(selectedRundownId === FOLLOW_LOADED_RUNDOWN_ID ? loadedRundownId : selectedRundownId);
|
useRundownSelection('cuesheet');
|
||||||
|
|
||||||
const actions = useScopedEntryActions(source.rundownId);
|
|
||||||
|
|
||||||
useWindowTitle('Cuesheet');
|
useWindowTitle('Cuesheet');
|
||||||
|
|
||||||
const isLocked = getIsNavigationLocked();
|
const isLocked = getIsNavigationLocked();
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<EntryActionsProvider actions={actions}>
|
<EditableRundownScopeProvider rundownId={scopedRundownId}>
|
||||||
<NavigationMenu isOpen={isMenuOpen} onClose={menuHandler.close} />
|
<NavigationMenu isOpen={isMenuOpen} onClose={menuHandler.close} />
|
||||||
<EntryEditModal rundown={source.rundown} />
|
<EntryEditModal />
|
||||||
<div className={styles.tableWrapper} data-testid='cuesheet'>
|
<div className={styles.tableWrapper} data-testid='cuesheet'>
|
||||||
<CuesheetOverview>
|
<CuesheetOverview>
|
||||||
{!isLocked && (
|
{!isLocked && (
|
||||||
@@ -42,13 +38,12 @@ export default function CuesheetPage() {
|
|||||||
</CuesheetOverview>
|
</CuesheetOverview>
|
||||||
<CuesheetProgress />
|
<CuesheetProgress />
|
||||||
<CuesheetTableWrapper
|
<CuesheetTableWrapper
|
||||||
source={source}
|
|
||||||
selectedRundownId={selectedRundownId}
|
selectedRundownId={selectedRundownId}
|
||||||
loadedRundownId={loadedRundownId}
|
loadedRundownId={loadedRundownId}
|
||||||
setSelectedRundownId={setSelectedRundownId}
|
setSelectedRundownId={setSelectedRundownId}
|
||||||
projectRundowns={projectRundowns}
|
projectRundowns={projectRundowns}
|
||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
</EntryActionsProvider>
|
</EditableRundownScopeProvider>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,19 +3,18 @@ import { memo, use, useMemo } from 'react';
|
|||||||
|
|
||||||
import Select from '../../common/components/select/Select';
|
import Select from '../../common/components/select/Select';
|
||||||
import { PresetContext } from '../../common/context/PresetContext';
|
import { PresetContext } from '../../common/context/PresetContext';
|
||||||
|
import { useRundownScope } from '../../common/context/RundownScopeContext';
|
||||||
import useCustomFields from '../../common/hooks-query/useCustomFields';
|
import useCustomFields from '../../common/hooks-query/useCustomFields';
|
||||||
import type { RundownSource } from '../../common/hooks-query/useScopedRundown';
|
import { FOLLOW_LOADED_RUNDOWN_ID } from '../../common/hooks/useRundownSelection';
|
||||||
import { AppMode } from '../../ontimeConfig';
|
import { AppMode } from '../../ontimeConfig';
|
||||||
import CuesheetDnd from './cuesheet-dnd/CuesheetDnd';
|
import CuesheetDnd from './cuesheet-dnd/CuesheetDnd';
|
||||||
import { makeCuesheetColumns } from './cuesheet-table/cuesheet-table-elements/cuesheetColsFactory';
|
import { makeCuesheetColumns } from './cuesheet-table/cuesheet-table-elements/cuesheetColsFactory';
|
||||||
import CuesheetTable from './cuesheet-table/CuesheetTable';
|
import CuesheetTable from './cuesheet-table/CuesheetTable';
|
||||||
import { useApplyCuesheetPolicy } from './useApplyCuesheetPolicy';
|
import { useApplyCuesheetPolicy } from './useApplyCuesheetPolicy';
|
||||||
import { FOLLOW_LOADED_RUNDOWN_ID } from './useCuesheetRundownSelection';
|
|
||||||
|
|
||||||
import styles from './CuesheetPage.module.scss';
|
import styles from './CuesheetPage.module.scss';
|
||||||
|
|
||||||
interface CuesheetTableWrapperProps {
|
interface CuesheetTableWrapperProps {
|
||||||
source: RundownSource;
|
|
||||||
selectedRundownId: MaybeString;
|
selectedRundownId: MaybeString;
|
||||||
loadedRundownId: string;
|
loadedRundownId: string;
|
||||||
setSelectedRundownId: (rundownId: string) => void;
|
setSelectedRundownId: (rundownId: string) => void;
|
||||||
@@ -24,15 +23,14 @@ interface CuesheetTableWrapperProps {
|
|||||||
|
|
||||||
export default memo(CuesheetTableWrapper);
|
export default memo(CuesheetTableWrapper);
|
||||||
function CuesheetTableWrapper({
|
function CuesheetTableWrapper({
|
||||||
source,
|
|
||||||
selectedRundownId,
|
selectedRundownId,
|
||||||
setSelectedRundownId,
|
setSelectedRundownId,
|
||||||
loadedRundownId,
|
loadedRundownId,
|
||||||
projectRundowns,
|
projectRundowns,
|
||||||
}: CuesheetTableWrapperProps) {
|
}: CuesheetTableWrapperProps) {
|
||||||
const preset = use(PresetContext);
|
const preset = use(PresetContext);
|
||||||
const isCurrentRundown = source.rundownId !== null && source.rundownId === loadedRundownId;
|
const { isLoaded } = useRundownScope();
|
||||||
const { cuesheetMode, setCuesheetMode } = useApplyCuesheetPolicy(preset, { canRunMode: isCurrentRundown });
|
const { cuesheetMode, setCuesheetMode } = useApplyCuesheetPolicy(preset, { canRunMode: isLoaded });
|
||||||
const { data: customFields } = useCustomFields();
|
const { data: customFields } = useCustomFields();
|
||||||
|
|
||||||
const columns = useMemo(
|
const columns = useMemo(
|
||||||
@@ -44,11 +42,9 @@ function CuesheetTableWrapper({
|
|||||||
<CuesheetDnd columns={columns}>
|
<CuesheetDnd columns={columns}>
|
||||||
<CuesheetTable
|
<CuesheetTable
|
||||||
columns={columns}
|
columns={columns}
|
||||||
source={source}
|
|
||||||
cuesheetMode={cuesheetMode}
|
cuesheetMode={cuesheetMode}
|
||||||
tableRoot='cuesheet'
|
tableRoot='cuesheet'
|
||||||
setCuesheetMode={setCuesheetMode}
|
setCuesheetMode={setCuesheetMode}
|
||||||
isCurrentRundown={isCurrentRundown}
|
|
||||||
insertElement={
|
insertElement={
|
||||||
<>
|
<>
|
||||||
<RundownSelect
|
<RundownSelect
|
||||||
|
|||||||
@@ -1,16 +1,13 @@
|
|||||||
import { Rundown } from 'ontime-types';
|
|
||||||
import { memo } from 'react';
|
import { memo } from 'react';
|
||||||
|
|
||||||
import Modal from '../../../common/components/modal/Modal';
|
import Modal from '../../../common/components/modal/Modal';
|
||||||
|
import useRundown from '../../../common/hooks-query/useRundown';
|
||||||
import CuesheetEntryEditor from '../../../features/rundown/entry-editor/CuesheetEventEditor';
|
import CuesheetEntryEditor from '../../../features/rundown/entry-editor/CuesheetEventEditor';
|
||||||
import { useEditModal } from './useEditModal';
|
import { useEditModal } from './useEditModal';
|
||||||
|
|
||||||
interface EntryEditModalProps {
|
|
||||||
rundown: Rundown;
|
|
||||||
}
|
|
||||||
|
|
||||||
export default memo(EntryEditModal);
|
export default memo(EntryEditModal);
|
||||||
function EntryEditModal({ rundown }: EntryEditModalProps) {
|
function EntryEditModal() {
|
||||||
|
const { data: rundown } = useRundown();
|
||||||
const entryId = useEditModal((state) => state.selectedEntryId);
|
const entryId = useEditModal((state) => state.selectedEntryId);
|
||||||
const closeModal = useEditModal((state) => state.clearSelection);
|
const closeModal = useEditModal((state) => state.clearSelection);
|
||||||
|
|
||||||
|
|||||||
@@ -14,7 +14,8 @@ import {
|
|||||||
import EmptyFill from '../../../common/components/state/EmptyFill';
|
import EmptyFill from '../../../common/components/state/EmptyFill';
|
||||||
import EmptyTableBody from '../../../common/components/state/EmptyTableBody';
|
import EmptyTableBody from '../../../common/components/state/EmptyTableBody';
|
||||||
import { useEntryActionsContext } from '../../../common/context/EntryActionsContext';
|
import { useEntryActionsContext } from '../../../common/context/EntryActionsContext';
|
||||||
import type { RundownSource } from '../../../common/hooks-query/useScopedRundown';
|
import { useRundownScope } from '../../../common/context/RundownScopeContext';
|
||||||
|
import { useFlatRundownWithMetadata, useScopedSelectedEventId } from '../../../common/hooks-query/useRundown';
|
||||||
import type { ExtendedEntry } from '../../../common/utils/rundownMetadata';
|
import type { ExtendedEntry } from '../../../common/utils/rundownMetadata';
|
||||||
import { usePersistedRundownOptions } from '../../../features/rundown/rundown.options';
|
import { usePersistedRundownOptions } from '../../../features/rundown/rundown.options';
|
||||||
import { useEventSelection } from '../../../features/rundown/useEventSelection';
|
import { useEventSelection } from '../../../features/rundown/useEventSelection';
|
||||||
@@ -41,20 +42,17 @@ import style from './CuesheetTable.module.scss';
|
|||||||
type CuesheetTableBaseProps = {
|
type CuesheetTableBaseProps = {
|
||||||
columns: CuesheetColumnDef[];
|
columns: CuesheetColumnDef[];
|
||||||
cuesheetMode: AppMode;
|
cuesheetMode: AppMode;
|
||||||
source: RundownSource;
|
|
||||||
insertElement?: ReactNode;
|
insertElement?: ReactNode;
|
||||||
};
|
};
|
||||||
|
|
||||||
type EditorCuesheetTableProps = CuesheetTableBaseProps & {
|
type EditorCuesheetTableProps = CuesheetTableBaseProps & {
|
||||||
tableRoot: 'editor';
|
tableRoot: 'editor';
|
||||||
setCuesheetMode?: undefined;
|
setCuesheetMode?: undefined;
|
||||||
isCurrentRundown?: undefined;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
type ViewCuesheetTableProps = CuesheetTableBaseProps & {
|
type ViewCuesheetTableProps = CuesheetTableBaseProps & {
|
||||||
tableRoot: 'cuesheet';
|
tableRoot: 'cuesheet';
|
||||||
setCuesheetMode: (mode: AppMode) => void;
|
setCuesheetMode: (mode: AppMode) => void;
|
||||||
isCurrentRundown?: boolean;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
type CuesheetTableProps = EditorCuesheetTableProps | ViewCuesheetTableProps;
|
type CuesheetTableProps = EditorCuesheetTableProps | ViewCuesheetTableProps;
|
||||||
@@ -62,13 +60,13 @@ type CuesheetTableProps = EditorCuesheetTableProps | ViewCuesheetTableProps;
|
|||||||
export default function CuesheetTable({
|
export default function CuesheetTable({
|
||||||
columns,
|
columns,
|
||||||
cuesheetMode,
|
cuesheetMode,
|
||||||
source,
|
|
||||||
tableRoot,
|
tableRoot,
|
||||||
setCuesheetMode,
|
setCuesheetMode,
|
||||||
isCurrentRundown,
|
|
||||||
insertElement,
|
insertElement,
|
||||||
}: CuesheetTableProps) {
|
}: CuesheetTableProps) {
|
||||||
const { flatRundown, status, selectedEventId } = source;
|
const { isLoaded: isCurrentRundown } = useRundownScope();
|
||||||
|
const { data: flatRundown, status } = useFlatRundownWithMetadata();
|
||||||
|
const selectedEventId = useScopedSelectedEventId();
|
||||||
const { updateEntry, updateTimer, addEntry } = useEntryActionsContext();
|
const { updateEntry, updateTimer, addEntry } = useEntryActionsContext();
|
||||||
const { getLocalizedString } = useTranslation();
|
const { getLocalizedString } = useTranslation();
|
||||||
const canCreateEntries = useCuesheetPermissions((state) => state.canCreateEntries) && cuesheetMode === AppMode.Edit;
|
const canCreateEntries = useCuesheetPermissions((state) => state.canCreateEntries) && cuesheetMode === AppMode.Edit;
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
import { lazy } from 'react';
|
import { lazy } from 'react';
|
||||||
|
|
||||||
|
import { EditableRundownScopeProvider } from '../../common/context/EditableRundownScopeProvider';
|
||||||
import TrackingPlaybackBar from '../../features/control/playback/tracking-playback-bar/TrackingPlaybackBar';
|
import TrackingPlaybackBar from '../../features/control/playback/tracking-playback-bar/TrackingPlaybackBar';
|
||||||
import { AppMode } from '../../ontimeConfig';
|
import { AppMode } from '../../ontimeConfig';
|
||||||
import TitleList from './title-list/TitleList';
|
import TitleList from './title-list/TitleList';
|
||||||
@@ -21,7 +22,9 @@ export default function Editor() {
|
|||||||
<TimerControl />
|
<TimerControl />
|
||||||
<MessageControl />
|
<MessageControl />
|
||||||
</div>
|
</div>
|
||||||
<Rundown />
|
<EditableRundownScopeProvider rundownId={null}>
|
||||||
|
<Rundown />
|
||||||
|
</EditableRundownScopeProvider>
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -29,14 +32,17 @@ export default function Editor() {
|
|||||||
if (layoutMode === EditorLayoutMode.TRACKING) {
|
if (layoutMode === EditorLayoutMode.TRACKING) {
|
||||||
return (
|
return (
|
||||||
<div id='panels' className={`${styles.panelContainer} ${styles.panelContainerTracking}`}>
|
<div id='panels' className={`${styles.panelContainer} ${styles.panelContainerTracking}`}>
|
||||||
<div className={styles.rundownLayout}>
|
{/* the titles and the rundown share a scope, so they follow one cursor */}
|
||||||
<div className={styles.titlesPanel}>
|
<EditableRundownScopeProvider rundownId={null}>
|
||||||
<TitleList mode={AppMode.Run} />
|
<div className={styles.rundownLayout}>
|
||||||
|
<div className={styles.titlesPanel}>
|
||||||
|
<TitleList mode={AppMode.Run} />
|
||||||
|
</div>
|
||||||
|
<div className={styles.rundownPanel}>
|
||||||
|
<Rundown />
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div className={styles.rundownPanel}>
|
</EditableRundownScopeProvider>
|
||||||
<Rundown />
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<TrackingPlaybackBar />
|
<TrackingPlaybackBar />
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
@@ -44,14 +50,16 @@ export default function Editor() {
|
|||||||
|
|
||||||
return (
|
return (
|
||||||
<div id='panels' className={styles.panelContainer}>
|
<div id='panels' className={styles.panelContainer}>
|
||||||
<div className={styles.rundownLayout}>
|
<EditableRundownScopeProvider rundownId={null}>
|
||||||
<div className={styles.titlesPanel}>
|
<div className={styles.rundownLayout}>
|
||||||
<TitleList mode={AppMode.Edit} />
|
<div className={styles.titlesPanel}>
|
||||||
|
<TitleList mode={AppMode.Edit} />
|
||||||
|
</div>
|
||||||
|
<div className={styles.rundownPanel}>
|
||||||
|
<Rundown />
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div className={styles.rundownPanel}>
|
</EditableRundownScopeProvider>
|
||||||
<Rundown />
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,11 +3,14 @@
|
|||||||
.error {
|
.error {
|
||||||
padding-inline: 0.5rem;
|
padding-inline: 0.5rem;
|
||||||
font-size: 1rem;
|
font-size: 1rem;
|
||||||
height: 3rem;
|
// rows grow when a match is shown from a note or custom field
|
||||||
|
min-height: 3rem;
|
||||||
|
padding-block: 0.35rem;
|
||||||
|
|
||||||
display: flex;
|
display: flex;
|
||||||
align-items: center;
|
align-items: center;
|
||||||
justify-content: space-between;
|
justify-content: space-between;
|
||||||
|
gap: 0.5rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
.entry[data-selected='true'] {
|
.entry[data-selected='true'] {
|
||||||
@@ -18,21 +21,47 @@
|
|||||||
color: $label-gray;
|
color: $label-gray;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.more {
|
||||||
|
padding-inline: 0.5rem;
|
||||||
|
padding-block: 0.75rem;
|
||||||
|
font-size: calc(1rem - 2px);
|
||||||
|
color: $label-gray;
|
||||||
|
border-top: 1px solid $gray-1000;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
.error {
|
.error {
|
||||||
color: $error-red;
|
color: $error-red;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.filters {
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.35rem;
|
||||||
|
padding-top: 0.75rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.filterLabel {
|
||||||
|
font-size: calc(1rem - 3px);
|
||||||
|
color: $label-gray;
|
||||||
|
margin-right: 0.15rem;
|
||||||
|
}
|
||||||
|
|
||||||
.data {
|
.data {
|
||||||
display: grid;
|
display: grid;
|
||||||
grid-template-areas:
|
grid-template-areas:
|
||||||
'index cue'
|
'index cue'
|
||||||
'index title';
|
'index title'
|
||||||
|
'index match';
|
||||||
column-gap: 1rem;
|
column-gap: 1rem;
|
||||||
grid-template-rows: min-content 1fr;
|
grid-template-rows: min-content 1fr;
|
||||||
|
min-width: 0;
|
||||||
|
|
||||||
.index {
|
.index {
|
||||||
grid-area: index;
|
grid-area: index;
|
||||||
background-color: var(--color, $gray-1000);
|
// background and text colour come from getAccessibleColour, which keeps the
|
||||||
|
// number legible whatever colour the user gave the entry
|
||||||
border-radius: 2px;
|
border-radius: 2px;
|
||||||
padding-block: 0.25rem;
|
padding-block: 0.25rem;
|
||||||
width: 3.5rem;
|
width: 3.5rem;
|
||||||
@@ -42,14 +71,33 @@
|
|||||||
|
|
||||||
.title {
|
.title {
|
||||||
grid-area: title;
|
grid-area: title;
|
||||||
|
white-space: nowrap;
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
}
|
}
|
||||||
|
|
||||||
.cue {
|
.cue {
|
||||||
grid-area: cue;
|
grid-area: cue;
|
||||||
font-size: calc(1rem - 2px);
|
font-size: calc(1rem - 2px);
|
||||||
color: $label-gray;
|
color: $label-gray;
|
||||||
max-height: 1em;
|
|
||||||
min-height: 0;
|
min-height: 0;
|
||||||
|
white-space: nowrap;
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
}
|
||||||
|
|
||||||
|
.match {
|
||||||
|
grid-area: match;
|
||||||
|
font-size: calc(1rem - 3px);
|
||||||
|
color: $label-gray;
|
||||||
|
white-space: nowrap;
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
}
|
||||||
|
|
||||||
|
.matchLabel {
|
||||||
|
color: $ui-white;
|
||||||
|
margin-right: 0.4rem;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -63,13 +111,14 @@
|
|||||||
color: $label-gray;
|
color: $label-gray;
|
||||||
}
|
}
|
||||||
|
|
||||||
.filterHint {
|
.count {
|
||||||
text-align: right;
|
text-align: right;
|
||||||
|
white-space: nowrap;
|
||||||
}
|
}
|
||||||
|
|
||||||
.em {
|
.go {
|
||||||
color: $ui-white;
|
white-space: nowrap;
|
||||||
margin-inline: 0.25rem;
|
padding-left: 1rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
.hints {
|
.hints {
|
||||||
@@ -98,7 +147,7 @@
|
|||||||
flex-direction: column;
|
flex-direction: column;
|
||||||
}
|
}
|
||||||
|
|
||||||
.filterHint {
|
.count {
|
||||||
text-align: left;
|
text-align: left;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,11 +1,12 @@
|
|||||||
import { useDebouncedCallback } from '@mantine/hooks';
|
import { MaybeString } from 'ontime-types';
|
||||||
import { SupportedEntry } from 'ontime-types';
|
import { KeyboardEvent, useDeferredValue, useEffect, useRef, useState } from 'react';
|
||||||
import { KeyboardEvent, useState } from 'react';
|
|
||||||
|
|
||||||
|
import ToggleButton from '../../../common/components/buttons/ToggleButton';
|
||||||
import Input from '../../../common/components/input/input/Input';
|
import Input from '../../../common/components/input/input/Input';
|
||||||
import Kbd from '../../../common/components/kbd/Kbd';
|
import Kbd from '../../../common/components/kbd/Kbd';
|
||||||
import Modal from '../../../common/components/modal/Modal';
|
import Modal from '../../../common/components/modal/Modal';
|
||||||
import useFinder from './useFinder';
|
import { getAccessibleColour } from '../../../common/utils/styleUtils';
|
||||||
|
import useFinder, { FinderResult } from './useFinder';
|
||||||
|
|
||||||
import style from './Finder.module.scss';
|
import style from './Finder.module.scss';
|
||||||
|
|
||||||
@@ -15,46 +16,76 @@ interface FinderProps {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export default function Finder({ isOpen, onClose }: FinderProps) {
|
export default function Finder({ isOpen, onClose }: FinderProps) {
|
||||||
const { find, select, results, error } = useFinder();
|
const [search, setSearch] = useState('');
|
||||||
const [selected, setSelected] = useState(0);
|
const [filter, setFilter] = useState<MaybeString>(null);
|
||||||
|
const [selectedId, setSelectedId] = useState<MaybeString>(null);
|
||||||
|
|
||||||
const debouncedFind = useDebouncedCallback(find, 100);
|
/**
|
||||||
|
* Keeps typing responsive while the list re-renders.
|
||||||
|
* The search itself is cheap, rendering the results is what costs.
|
||||||
|
*/
|
||||||
|
const deferredSearch = useDeferredValue(search);
|
||||||
|
const { select, results, error, total, filters, appliedFilter } = useFinder(deferredSearch, filter);
|
||||||
|
|
||||||
|
const inputRef = useRef<HTMLInputElement>(null);
|
||||||
|
const activeRef = useRef<HTMLLIElement>(null);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* We track the selection by ID so that it survives the result list changing under us:
|
||||||
|
* an entry that no longer exists falls back to the first result instead of dangling past the end
|
||||||
|
*/
|
||||||
|
const activeIndex = Math.max(
|
||||||
|
0,
|
||||||
|
results.findIndex((entry) => entry.id === selectedId),
|
||||||
|
);
|
||||||
|
const activeEntry = results.at(activeIndex);
|
||||||
|
|
||||||
|
/** keep the highlighted entry in view while navigating with the keyboard */
|
||||||
|
useEffect(() => {
|
||||||
|
activeRef.current?.scrollIntoView({ block: 'nearest' });
|
||||||
|
}, [activeEntry?.id]);
|
||||||
|
|
||||||
const navigate = (event: KeyboardEvent<HTMLDivElement>) => {
|
const navigate = (event: KeyboardEvent<HTMLDivElement>) => {
|
||||||
|
// pressing the search shortcut again selects the query, ready to be replaced
|
||||||
|
if ((event.metaKey || event.ctrlKey) && event.key === 'f') {
|
||||||
|
event.preventDefault();
|
||||||
|
inputRef.current?.select();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
// all operations need results
|
// all operations need results
|
||||||
if (results.length === 0) {
|
if (results.length === 0) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
if (event.key === 'ArrowDown') {
|
if (event.key === 'ArrowDown') {
|
||||||
setSelected((prev) => (prev + 1) % results.length);
|
setSelectedId(results[(activeIndex + 1) % results.length].id);
|
||||||
}
|
}
|
||||||
if (event.key === 'ArrowUp') {
|
if (event.key === 'ArrowUp') {
|
||||||
setSelected((prev) => (prev - 1 + results.length) % results.length);
|
setSelectedId(results[(activeIndex - 1 + results.length) % results.length].id);
|
||||||
}
|
}
|
||||||
if (event.key === 'Enter') {
|
if (event.key === 'Enter') {
|
||||||
event.preventDefault();
|
event.preventDefault();
|
||||||
event.stopPropagation();
|
event.stopPropagation();
|
||||||
submit();
|
submit(activeEntry);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
const submit = () => {
|
const submit = (entry: FinderResult | undefined) => {
|
||||||
const selectedEvent = results[selected];
|
if (!entry) {
|
||||||
select(selectedEvent);
|
return;
|
||||||
|
}
|
||||||
|
select(entry);
|
||||||
onClose();
|
onClose();
|
||||||
};
|
};
|
||||||
|
|
||||||
const handleMouseMoveEvent = (event: React.MouseEvent<HTMLUListElement>) => {
|
/** Scopes the search to a single field, or back to all fields when tapped again */
|
||||||
const target = event.target as HTMLElement;
|
const handleFilter = (filterKey: string) => {
|
||||||
const li = target.closest('li');
|
setFilter((previous) => (previous === filterKey ? null : filterKey));
|
||||||
if (li) {
|
inputRef.current?.focus();
|
||||||
const index = Number(li.dataset.index);
|
|
||||||
if (!isNaN(index)) {
|
|
||||||
setSelected(index);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
};
|
||||||
|
|
||||||
|
const hiddenResults = total - results.length;
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Modal
|
<Modal
|
||||||
title=''
|
title=''
|
||||||
@@ -63,35 +94,68 @@ export default function Finder({ isOpen, onClose }: FinderProps) {
|
|||||||
showBackdrop
|
showBackdrop
|
||||||
bodyElements={
|
bodyElements={
|
||||||
<div onKeyDown={navigate}>
|
<div onKeyDown={navigate}>
|
||||||
<Input height='large' fluid onChange={debouncedFind} placeholder='Search...' />
|
<Input
|
||||||
<ul className={style.scrollContainer} onMouseMove={handleMouseMoveEvent}>
|
ref={inputRef}
|
||||||
|
height='large'
|
||||||
|
fluid
|
||||||
|
autoFocus
|
||||||
|
value={search}
|
||||||
|
onChange={(event) => setSearch(event.target.value)}
|
||||||
|
placeholder='Search...'
|
||||||
|
/>
|
||||||
|
<div className={style.filters} data-testid='finder-filters'>
|
||||||
|
<span className={style.filterLabel}>Filter by</span>
|
||||||
|
{filters.map((option) => (
|
||||||
|
<ToggleButton
|
||||||
|
key={option.key}
|
||||||
|
pressed={appliedFilter === option.key}
|
||||||
|
size='small'
|
||||||
|
onClick={() => handleFilter(option.key)}
|
||||||
|
>
|
||||||
|
{option.label}
|
||||||
|
</ToggleButton>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
<ul className={style.scrollContainer}>
|
||||||
{error && <li className={style.error}>{error}</li>}
|
{error && <li className={style.error}>{error}</li>}
|
||||||
{results.length === 0 && <li className={style.empty}>No results</li>}
|
{!error && results.length === 0 && <li className={style.empty}>No results</li>}
|
||||||
{results.length > 0 &&
|
{results.map((entry) => {
|
||||||
results.map((entry, index) => {
|
const isSelected = activeEntry?.id === entry.id;
|
||||||
const isSelected = selected === index;
|
// the title and cue are already on the row, a match anywhere else needs showing
|
||||||
const displayIndex = entry.type === SupportedEntry.Event ? entry.eventIndex : '-';
|
const showMatch = entry.match !== null && entry.match.key !== 'title' && entry.match.key !== 'cue';
|
||||||
const displayCue = 'cue' in entry ? entry.cue : '';
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<li
|
<li
|
||||||
key={entry.id}
|
key={entry.id}
|
||||||
className={style.entry}
|
ref={isSelected ? activeRef : undefined}
|
||||||
data-selected={isSelected}
|
className={style.entry}
|
||||||
data-index={index}
|
data-testid='finder-result'
|
||||||
onClick={submit}
|
data-selected={isSelected}
|
||||||
>
|
onClick={() => submit(entry)}
|
||||||
<div className={style.data}>
|
onPointerEnter={() => setSelectedId(entry.id)}
|
||||||
<div className={style.index} style={{ '--color': entry.colour }}>
|
>
|
||||||
{displayIndex}
|
<div className={style.data}>
|
||||||
</div>
|
<div className={style.index} style={getAccessibleColour(entry.colour)}>
|
||||||
<div className={style.cue}>{displayCue}</div>
|
{entry.eventIndex ?? '-'}
|
||||||
<div className={style.title}>{entry.title}</div>
|
|
||||||
</div>
|
</div>
|
||||||
{isSelected && <span>Go ⏎</span>}
|
<div className={style.cue}>{entry.cue}</div>
|
||||||
</li>
|
<div className={style.title}>{entry.title}</div>
|
||||||
);
|
{showMatch && (
|
||||||
})}
|
<div className={style.match} data-testid='finder-result-match'>
|
||||||
|
<span className={style.matchLabel}>{entry.match?.label}</span>
|
||||||
|
{entry.match?.excerpt}
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
{isSelected && <span className={style.go}>Go ⏎</span>}
|
||||||
|
</li>
|
||||||
|
);
|
||||||
|
})}
|
||||||
|
{hiddenResults > 0 && (
|
||||||
|
<li className={style.more} data-testid='finder-more'>
|
||||||
|
{hiddenResults} more {hiddenResults === 1 ? 'result' : 'results'} — keep typing to narrow the search
|
||||||
|
</li>
|
||||||
|
)}
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
}
|
}
|
||||||
@@ -112,10 +176,11 @@ export default function Finder({ isOpen, onClose }: FinderProps) {
|
|||||||
Close
|
Close
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
<div className={style.filterHint}>
|
{total > 0 && (
|
||||||
Filter by <span className={style.em}>cue</span>, <span className={style.em}>index</span>, or
|
<div className={style.count} data-testid='finder-count'>
|
||||||
<span className={style.em}>title</span>
|
{hiddenResults > 0 ? `Showing ${results.length} of ${total}` : `${total} result${total === 1 ? '' : 's'}`}
|
||||||
</div>
|
</div>
|
||||||
|
)}
|
||||||
</div>
|
</div>
|
||||||
}
|
}
|
||||||
/>
|
/>
|
||||||
|
|||||||
@@ -0,0 +1,162 @@
|
|||||||
|
import { CustomFields, OntimeDelay, OntimeEvent, OntimeGroup, OntimeMilestone, SupportedEntry } from 'ontime-types';
|
||||||
|
|
||||||
|
import { parseQuery, searchByIndex, searchByText } from './useFinder';
|
||||||
|
|
||||||
|
function makeEvent(id: string, overrides: Partial<OntimeEvent> = {}): OntimeEvent {
|
||||||
|
return {
|
||||||
|
type: SupportedEntry.Event,
|
||||||
|
id,
|
||||||
|
cue: '',
|
||||||
|
title: '',
|
||||||
|
note: '',
|
||||||
|
colour: '#000000',
|
||||||
|
custom: {},
|
||||||
|
parent: null,
|
||||||
|
...overrides,
|
||||||
|
} as OntimeEvent;
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeGroup(id: string, overrides: Partial<OntimeGroup> = {}): OntimeGroup {
|
||||||
|
return {
|
||||||
|
type: SupportedEntry.Group,
|
||||||
|
id,
|
||||||
|
title: '',
|
||||||
|
note: '',
|
||||||
|
colour: '#000000',
|
||||||
|
custom: {},
|
||||||
|
...overrides,
|
||||||
|
} as OntimeGroup;
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeMilestone(id: string, overrides: Partial<OntimeMilestone> = {}): OntimeMilestone {
|
||||||
|
return {
|
||||||
|
type: SupportedEntry.Milestone,
|
||||||
|
id,
|
||||||
|
cue: '',
|
||||||
|
title: '',
|
||||||
|
note: '',
|
||||||
|
colour: '#000000',
|
||||||
|
custom: {},
|
||||||
|
parent: null,
|
||||||
|
...overrides,
|
||||||
|
} as OntimeMilestone;
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeDelay(id: string): OntimeDelay {
|
||||||
|
return { type: SupportedEntry.Delay, id, duration: 1000, parent: null };
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('parseQuery()', () => {
|
||||||
|
const filters = [
|
||||||
|
{ key: 'cue', label: 'Cue' },
|
||||||
|
{ key: 'Camera_Notes', label: 'Camera Notes' },
|
||||||
|
];
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
['cue 12', { filterKey: 'cue', searchString: '12' }],
|
||||||
|
['cue:12', { filterKey: 'cue', searchString: '12' }],
|
||||||
|
['camera_notes:wide', { filterKey: 'Camera_Notes', searchString: 'wide' }],
|
||||||
|
])('parses the field prefix in %s', (searchValue, expected) => {
|
||||||
|
expect(parseQuery(searchValue, filters)).toStrictEqual(expected);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('keeps an unprefixed query as a search across all fields', () => {
|
||||||
|
expect(parseQuery('zebrafish', filters)).toStrictEqual({ filterKey: null, searchString: 'zebrafish' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('recognises a filter before any search text has been entered', () => {
|
||||||
|
expect(parseQuery('cue', filters)).toStrictEqual({ filterKey: 'cue', searchString: '' });
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('searchByText()', () => {
|
||||||
|
const customFields: CustomFields = {
|
||||||
|
Camera_Notes: { type: 'text', label: 'Camera Notes', colour: '#000000' },
|
||||||
|
Slide: { type: 'image', label: 'Slide', colour: '#000000' },
|
||||||
|
};
|
||||||
|
|
||||||
|
it('searches cue, title, note, and text custom fields in rundown order', () => {
|
||||||
|
const data = [
|
||||||
|
makeMilestone('milestone', { cue: 'needle' }),
|
||||||
|
makeGroup('group', { title: 'needle' }),
|
||||||
|
makeEvent('note', { note: 'find the needle here' }),
|
||||||
|
makeEvent('custom', { custom: { Camera_Notes: 'needle' } }),
|
||||||
|
];
|
||||||
|
|
||||||
|
const outcome = searchByText(data, customFields, null, 'needle');
|
||||||
|
|
||||||
|
expect(outcome.results.map(({ id, match }) => ({ id, field: match?.key }))).toStrictEqual([
|
||||||
|
{ id: 'milestone', field: 'cue' },
|
||||||
|
{ id: 'group', field: 'title' },
|
||||||
|
{ id: 'note', field: 'note' },
|
||||||
|
{ id: 'custom', field: 'Camera_Notes' },
|
||||||
|
]);
|
||||||
|
expect(outcome.total).toBe(4);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('searches only the selected field', () => {
|
||||||
|
const data = [
|
||||||
|
makeEvent('title', { title: 'needle' }),
|
||||||
|
makeEvent('note', { note: 'needle' }),
|
||||||
|
makeEvent('custom', { custom: { Camera_Notes: 'needle' } }),
|
||||||
|
];
|
||||||
|
|
||||||
|
const outcome = searchByText(data, customFields, 'note', 'needle');
|
||||||
|
|
||||||
|
expect(outcome.results.map((result) => result.id)).toStrictEqual(['note']);
|
||||||
|
expect(outcome.total).toBe(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('reports the first matching field so the result can explain why it matched', () => {
|
||||||
|
const data = [makeEvent('event', { cue: 'NEEDLE', title: 'another needle' })];
|
||||||
|
|
||||||
|
const outcome = searchByText(data, customFields, null, 'needle');
|
||||||
|
|
||||||
|
expect(outcome.results[0].match).toStrictEqual({ key: 'cue', label: 'Cue', excerpt: 'NEEDLE' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not search image custom fields', () => {
|
||||||
|
const data = [makeEvent('image-only', { custom: { Slide: 'needle' } })];
|
||||||
|
|
||||||
|
expect(searchByText(data, customFields, null, 'needle')).toStrictEqual({ results: [], error: null, total: 0 });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('reports the full match count while limiting rendered results', () => {
|
||||||
|
const data = Array.from({ length: 51 }, (_, index) => makeEvent(String(index), { title: 'needle' }));
|
||||||
|
|
||||||
|
const outcome = searchByText(data, customFields, null, 'needle');
|
||||||
|
|
||||||
|
expect(outcome.results).toHaveLength(50);
|
||||||
|
expect(outcome.total).toBe(51);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('searchByIndex()', () => {
|
||||||
|
it('counts only events while preserving the flat rundown position', () => {
|
||||||
|
const data = [
|
||||||
|
makeGroup('group'),
|
||||||
|
makeDelay('delay'),
|
||||||
|
makeEvent('first'),
|
||||||
|
makeMilestone('milestone'),
|
||||||
|
makeEvent('second'),
|
||||||
|
];
|
||||||
|
|
||||||
|
const outcome = searchByIndex(data, '2');
|
||||||
|
|
||||||
|
expect(outcome.results).toHaveLength(1);
|
||||||
|
expect(outcome.results[0]).toMatchObject({ id: 'second', index: 4, eventIndex: 2 });
|
||||||
|
expect(outcome.total).toBe(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it.each(['0', 'not-a-number'])('rejects invalid index %s', (index) => {
|
||||||
|
expect(searchByIndex([makeEvent('event')], index)).toStrictEqual({
|
||||||
|
results: [],
|
||||||
|
error: 'Invalid index',
|
||||||
|
total: 0,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns no result when the event index is beyond the rundown', () => {
|
||||||
|
expect(searchByIndex([makeEvent('event')], '2')).toStrictEqual({ results: [], error: null, total: 0 });
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,239 +1,259 @@
|
|||||||
import { EntryId, MaybeString, SupportedEntry, isOntimeEvent, isOntimeGroup, isOntimeMilestone } from 'ontime-types';
|
import {
|
||||||
import { ChangeEvent, useCallback, useEffect, useRef, useState } from 'react';
|
CustomFields,
|
||||||
|
EntryId,
|
||||||
|
MaybeNumber,
|
||||||
|
MaybeString,
|
||||||
|
OntimeEntry,
|
||||||
|
OntimeEvent,
|
||||||
|
OntimeGroup,
|
||||||
|
OntimeMilestone,
|
||||||
|
isOntimeDelay,
|
||||||
|
isOntimeEvent,
|
||||||
|
} from 'ontime-types';
|
||||||
|
import { useCallback, useMemo } from 'react';
|
||||||
|
|
||||||
|
import useCustomFields from '../../../common/hooks-query/useCustomFields';
|
||||||
import { useFlatRundown } from '../../../common/hooks-query/useRundown';
|
import { useFlatRundown } from '../../../common/hooks-query/useRundown';
|
||||||
import { useSelectAndRevealEntry } from '../../../features/rundown/useSelectAndRevealEntry';
|
import { useSelectAndRevealEntry } from '../../../features/rundown/useSelectAndRevealEntry';
|
||||||
|
|
||||||
const maxResults = 12;
|
/** How many results we render, the total number of matches is reported separately */
|
||||||
|
const maxResults = 50;
|
||||||
|
/** Notes can hold a whole script, we only show enough to explain the match */
|
||||||
|
const excerptPadding = 40;
|
||||||
|
|
||||||
type FilterableGroup = {
|
const indexFilter = 'index';
|
||||||
type: SupportedEntry.Group;
|
|
||||||
id: EntryId;
|
|
||||||
index: number;
|
|
||||||
title: string;
|
|
||||||
colour: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
type FilterableEvent = {
|
/** Everything except delays, which carry no text to search */
|
||||||
type: SupportedEntry.Event;
|
type SearchableEntry = OntimeEvent | OntimeGroup | OntimeMilestone;
|
||||||
|
|
||||||
|
type FinderFilter = { key: string; label: string };
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Offered to the user as filter badges. Index is a positional lookup rather than a
|
||||||
|
* text field, so it is handled separately from the fields a search runs over.
|
||||||
|
*/
|
||||||
|
const staticFilters: FinderFilter[] = [
|
||||||
|
{ key: indexFilter, label: 'Index' },
|
||||||
|
{ key: 'cue', label: 'Cue' },
|
||||||
|
{ key: 'title', label: 'Title' },
|
||||||
|
{ key: 'note', label: 'Note' },
|
||||||
|
];
|
||||||
|
|
||||||
|
/** Why an entry matched, so the UI can show the user */
|
||||||
|
type FinderMatch = { key: string; label: string; excerpt: string };
|
||||||
|
|
||||||
|
export type FinderResult = {
|
||||||
id: EntryId;
|
id: EntryId;
|
||||||
|
/** position in the flat rundown, which is how the rundown reveals an entry */
|
||||||
index: number;
|
index: number;
|
||||||
eventIndex: number;
|
/** 1-based position among events, null for groups and milestones */
|
||||||
|
eventIndex: MaybeNumber;
|
||||||
title: string;
|
title: string;
|
||||||
|
/** groups have no cue */
|
||||||
cue: string;
|
cue: string;
|
||||||
colour: string;
|
colour: string;
|
||||||
parent: MaybeString;
|
parent: MaybeString;
|
||||||
|
/** absent when the entry was found by index rather than by matching text */
|
||||||
|
match: FinderMatch | null;
|
||||||
};
|
};
|
||||||
|
|
||||||
type FilterableMilestone = {
|
type SearchOutcome = { results: FinderResult[]; error: MaybeString; total: number };
|
||||||
type: SupportedEntry.Milestone;
|
|
||||||
id: EntryId;
|
|
||||||
index: number;
|
|
||||||
title: string;
|
|
||||||
cue: string;
|
|
||||||
colour: string;
|
|
||||||
parent: MaybeString;
|
|
||||||
};
|
|
||||||
|
|
||||||
type FilterableEntry = FilterableGroup | FilterableEvent | FilterableMilestone;
|
const noResults: SearchOutcome = { results: [], error: null, total: 0 };
|
||||||
|
|
||||||
export default function useFinder() {
|
/** Groups are the only searchable entry with neither a cue nor a parent */
|
||||||
const { data, rundownId } = useFlatRundown();
|
function toResult(entry: SearchableEntry, index: number, eventIndex: MaybeNumber, match: FinderMatch | null) {
|
||||||
const [results, setResults] = useState<FilterableEntry[]>([]);
|
return {
|
||||||
const [error, setError] = useState<MaybeString>(null);
|
id: entry.id,
|
||||||
const lastSearchString = useRef('');
|
index,
|
||||||
|
eventIndex,
|
||||||
|
title: entry.title,
|
||||||
|
cue: 'cue' in entry ? entry.cue : '',
|
||||||
|
colour: entry.colour,
|
||||||
|
parent: 'parent' in entry ? entry.parent : null,
|
||||||
|
match,
|
||||||
|
} satisfies FinderResult;
|
||||||
|
}
|
||||||
|
|
||||||
const selectAndRevealEntry = useSelectAndRevealEntry(rundownId);
|
/** Shows enough of a long value for the user to see why it matched */
|
||||||
|
function makeExcerpt(value: string, matchIndex: number, searchLength: number): string {
|
||||||
|
const start = Math.max(0, matchIndex - excerptPadding);
|
||||||
|
const end = Math.min(value.length, matchIndex + searchLength + excerptPadding);
|
||||||
|
return `${start > 0 ? '…' : ''}${value.slice(start, end)}${end < value.length ? '…' : ''}`;
|
||||||
|
}
|
||||||
|
|
||||||
/** Filters the rundown to a given evaluation */
|
/**
|
||||||
const find = useCallback(
|
* The first field of an entry to contain the search string, if any.
|
||||||
(event: ChangeEvent<HTMLInputElement>) => {
|
* Fields are tried in the order we prefer to report a match.
|
||||||
if (!data || data.length === 0) {
|
*/
|
||||||
setError('No data');
|
function findMatch(
|
||||||
return;
|
entry: SearchableEntry,
|
||||||
}
|
customFields: CustomFields,
|
||||||
setError(null);
|
filterKey: MaybeString,
|
||||||
|
searchString: string,
|
||||||
|
): FinderMatch | null {
|
||||||
|
function check(key: string, label: string, value: string): FinderMatch | null {
|
||||||
|
if (!value || (filterKey !== null && key !== filterKey)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
const matchIndex = value.toLowerCase().indexOf(searchString);
|
||||||
|
if (matchIndex === -1) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
return { key, label, excerpt: makeExcerpt(value, matchIndex, searchString.length) };
|
||||||
|
}
|
||||||
|
|
||||||
if (event.target.value === '') {
|
// groups have no cue, the rest is common to every searchable entry
|
||||||
setResults([]);
|
const fromCue = 'cue' in entry ? check('cue', 'Cue', entry.cue) : null;
|
||||||
return;
|
const match = fromCue ?? check('title', 'Title', entry.title) ?? check('note', 'Note', entry.note);
|
||||||
}
|
if (match !== null) {
|
||||||
|
return match;
|
||||||
|
}
|
||||||
|
|
||||||
const searchValue = event.target.value.toLowerCase();
|
// custom fields are named by the project, so these can only be reached generically
|
||||||
lastSearchString.current = searchValue;
|
for (const [key, value] of Object.entries(entry.custom)) {
|
||||||
|
const definition = customFields[key];
|
||||||
|
if (definition?.type !== 'text') {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
const custom = check(key, definition.label || key, value);
|
||||||
|
if (custom) return custom;
|
||||||
|
}
|
||||||
|
|
||||||
if (searchValue.startsWith('index ')) {
|
return null;
|
||||||
const searchString = searchValue.slice('index '.length).trim();
|
}
|
||||||
const { results, error } = searchByIndex(searchString);
|
|
||||||
setResults(results);
|
|
||||||
setError(error);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (searchValue.startsWith('cue ')) {
|
/**
|
||||||
const searchString = searchValue.slice('cue '.length).trim();
|
* Splits the raw search value into an optional field filter and the text to look for.
|
||||||
const { results, error } = searchByCue(searchString);
|
* Both `cue 12` and `cue:12` are accepted so that typing agrees with the filter badges.
|
||||||
setResults(results);
|
*/
|
||||||
setError(error);
|
export function parseQuery(searchValue: string, filters: FinderFilter[]) {
|
||||||
return;
|
for (const filter of filters) {
|
||||||
}
|
// the search value is already lowercased, custom field keys are not
|
||||||
|
const prefix = filter.key.toLowerCase();
|
||||||
|
if (searchValue === prefix) {
|
||||||
|
return { filterKey: filter.key, searchString: '' };
|
||||||
|
}
|
||||||
|
if (searchValue.startsWith(`${prefix} `) || searchValue.startsWith(`${prefix}:`)) {
|
||||||
|
return { filterKey: filter.key, searchString: searchValue.slice(prefix.length + 1).trim() };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return { filterKey: null, searchString: searchValue };
|
||||||
|
}
|
||||||
|
|
||||||
const searchString = searchValue.startsWith('title ') ? searchValue.slice('title '.length).trim() : searchValue;
|
/** Finds the single event at a 1-based position in the rundown */
|
||||||
const { results, error } = searchByTitle(searchString);
|
export function searchByIndex(data: OntimeEntry[], indexString: string): SearchOutcome {
|
||||||
setResults(results);
|
const target = Number(indexString);
|
||||||
setError(error);
|
if (isNaN(target) || target < 1) {
|
||||||
|
return { ...noResults, error: 'Invalid index' };
|
||||||
|
}
|
||||||
|
|
||||||
/** Returns a single item with a matching index */
|
let eventIndex = 0;
|
||||||
function searchByIndex(searchString: string) {
|
for (let i = 0; i < data.length; i++) {
|
||||||
const searchIndex = Number(searchString);
|
const entry = data[i];
|
||||||
if (isNaN(searchIndex) || searchIndex < 1) {
|
if (!isOntimeEvent(entry)) {
|
||||||
return { results: [], error: 'Invalid index' };
|
continue;
|
||||||
}
|
}
|
||||||
|
eventIndex++;
|
||||||
|
if (eventIndex === target) {
|
||||||
|
return { results: [toResult(entry, i, eventIndex, null)], error: null, total: 1 };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
if (searchIndex > data.length) {
|
return noResults;
|
||||||
return { results: [], error: null };
|
}
|
||||||
}
|
|
||||||
|
|
||||||
// indexes exposed to the UI are 1-based
|
/**
|
||||||
let eventIndex = 1;
|
* Matches entries on a single field when one is selected, otherwise on every text field.
|
||||||
const results: FilterableEvent[] = [];
|
* Results keep rundown order, which keeps them predictable during a show.
|
||||||
for (let i = 0; i < data.length; i++) {
|
*/
|
||||||
const event = data[i];
|
export function searchByText(
|
||||||
if (isOntimeEvent(event)) {
|
data: OntimeEntry[],
|
||||||
if (eventIndex === searchIndex) {
|
customFields: CustomFields,
|
||||||
results.push({
|
filterKey: MaybeString,
|
||||||
type: SupportedEntry.Event,
|
searchString: string,
|
||||||
id: event.id,
|
): SearchOutcome {
|
||||||
index: i,
|
const results: FinderResult[] = [];
|
||||||
eventIndex,
|
let total = 0;
|
||||||
title: event.title,
|
// indexes exposed to the UI are 1-based
|
||||||
cue: event.cue,
|
let eventIndex = 0;
|
||||||
colour: event.colour,
|
|
||||||
parent: event.parent,
|
|
||||||
} satisfies FilterableEvent);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
eventIndex++;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return { results, error: null };
|
for (let i = 0; i < data.length; i++) {
|
||||||
}
|
const entry = data[i];
|
||||||
|
if (isOntimeDelay(entry)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
const isEvent = isOntimeEvent(entry);
|
||||||
|
if (isEvent) {
|
||||||
|
eventIndex++;
|
||||||
|
}
|
||||||
|
|
||||||
/** Returns maxResults of OntimeEvents that match the cue field */
|
const match = findMatch(entry, customFields, filterKey, searchString);
|
||||||
function searchByCue(searchString: string) {
|
if (match === null) {
|
||||||
// indexes exposed to the UI are 1-based
|
continue;
|
||||||
let eventIndex = 1;
|
}
|
||||||
// limit amount of results we show
|
|
||||||
let remaining = maxResults;
|
|
||||||
const results: FilterableEvent[] = [];
|
|
||||||
|
|
||||||
for (let i = 0; i < data.length; i++) {
|
total++;
|
||||||
if (remaining <= 0) {
|
if (results.length < maxResults) {
|
||||||
break;
|
results.push(toResult(entry, i, isEvent ? eventIndex : null, match));
|
||||||
}
|
}
|
||||||
const event = data[i];
|
}
|
||||||
if (isOntimeEvent(event)) {
|
|
||||||
if (event.cue.toLowerCase().includes(searchString)) {
|
|
||||||
remaining--;
|
|
||||||
results.push({
|
|
||||||
type: SupportedEntry.Event,
|
|
||||||
id: event.id,
|
|
||||||
index: i,
|
|
||||||
eventIndex,
|
|
||||||
title: event.title,
|
|
||||||
cue: event.cue,
|
|
||||||
colour: event.colour,
|
|
||||||
parent: event.parent,
|
|
||||||
} satisfies FilterableEvent);
|
|
||||||
}
|
|
||||||
eventIndex++;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return { results, error: null };
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Returns maxResults of OntimeEvents that match the title field*/
|
return { results, error: null, total };
|
||||||
function searchByTitle(searchString: string) {
|
}
|
||||||
// indexes exposed to the UI are 1-based
|
|
||||||
let eventIndex = 1;
|
|
||||||
// limit amount of results we show
|
|
||||||
let remaining = maxResults;
|
|
||||||
const results: FilterableEntry[] = [];
|
|
||||||
|
|
||||||
for (let i = 0; i < data.length; i++) {
|
/**
|
||||||
if (remaining <= 0) {
|
* @param searchValue - the text the user is looking for
|
||||||
break;
|
* @param activeFilter - a field selected from the filter badges, if any
|
||||||
}
|
*/
|
||||||
|
export default function useFinder(searchValue: string, activeFilter: MaybeString) {
|
||||||
|
const { data } = useFlatRundown();
|
||||||
|
const { data: customFields } = useCustomFields();
|
||||||
|
|
||||||
const entry = data[i];
|
const selectAndRevealEntry = useSelectAndRevealEntry();
|
||||||
if (isOntimeEvent(entry)) {
|
|
||||||
if (entry.title.toLowerCase().includes(searchString)) {
|
/** The filters offered to the user: the fixed fields plus whatever the project defines */
|
||||||
remaining--;
|
const filters = useMemo<FinderFilter[]>(() => {
|
||||||
results.push({
|
const customFilters = Object.entries(customFields)
|
||||||
type: SupportedEntry.Event,
|
.filter(([_key, field]) => field.type === 'text')
|
||||||
id: entry.id,
|
.map(([key, field]) => ({ key, label: field.label || key }));
|
||||||
index: i,
|
return [...staticFilters, ...customFilters];
|
||||||
eventIndex,
|
}, [customFields]);
|
||||||
title: entry.title,
|
|
||||||
cue: entry.cue,
|
const { results, error, total, appliedFilter } = useMemo(() => {
|
||||||
colour: entry.colour,
|
if (data.length === 0) {
|
||||||
parent: entry.parent,
|
return { ...noResults, error: 'No data', appliedFilter: activeFilter };
|
||||||
} satisfies FilterableEvent);
|
}
|
||||||
}
|
|
||||||
eventIndex++;
|
const normalised = searchValue.trim().toLowerCase();
|
||||||
} else if (isOntimeGroup(entry)) {
|
if (normalised === '') {
|
||||||
if (entry.title.toLowerCase().includes(searchString)) {
|
return { ...noResults, appliedFilter: activeFilter };
|
||||||
remaining--;
|
}
|
||||||
results.push({
|
|
||||||
type: SupportedEntry.Group,
|
/**
|
||||||
id: entry.id,
|
* If a badge is selected it scopes the search; otherwise, keyword prefixes in the input
|
||||||
index: i,
|
* (e.g. "cue:" / "title:") are parsed and the matching badge is highlighted.
|
||||||
title: entry.title,
|
*/
|
||||||
colour: entry.colour,
|
const { filterKey, searchString } = activeFilter
|
||||||
} satisfies FilterableGroup);
|
? { filterKey: activeFilter, searchString: normalised }
|
||||||
}
|
: parseQuery(normalised, filters);
|
||||||
} else if (isOntimeMilestone(entry)) {
|
|
||||||
if (entry.title.toLowerCase().includes(searchString)) {
|
if (filterKey === indexFilter) {
|
||||||
remaining--;
|
return { ...searchByIndex(data, searchString), appliedFilter: filterKey };
|
||||||
results.push({
|
}
|
||||||
type: SupportedEntry.Milestone,
|
if (searchString === '') {
|
||||||
id: entry.id,
|
// a filter is selected, but there is nothing to match on yet
|
||||||
index: i,
|
return { ...noResults, appliedFilter: filterKey };
|
||||||
title: entry.title,
|
}
|
||||||
cue: entry.cue,
|
return { ...searchByText(data, customFields, filterKey, searchString), appliedFilter: filterKey };
|
||||||
colour: entry.colour,
|
}, [data, customFields, filters, searchValue, activeFilter]);
|
||||||
parent: entry.parent,
|
|
||||||
} satisfies FilterableMilestone);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return { results, error: null };
|
|
||||||
}
|
|
||||||
},
|
|
||||||
[data],
|
|
||||||
);
|
|
||||||
|
|
||||||
const select = useCallback(
|
const select = useCallback(
|
||||||
(selectedEvent: FilterableEntry) => {
|
(result: FinderResult) => {
|
||||||
selectAndRevealEntry({
|
selectAndRevealEntry({ id: result.id, index: result.index, parent: result.parent });
|
||||||
id: selectedEvent.id,
|
|
||||||
index: selectedEvent.index,
|
|
||||||
parent: 'parent' in selectedEvent ? selectedEvent.parent : null,
|
|
||||||
});
|
|
||||||
},
|
},
|
||||||
[selectAndRevealEntry],
|
[selectAndRevealEntry],
|
||||||
);
|
);
|
||||||
|
|
||||||
/** clear results when source data changes */
|
return { select, results, error, total, filters, appliedFilter };
|
||||||
useEffect(() => {
|
|
||||||
setResults([]);
|
|
||||||
setError(null);
|
|
||||||
// fake a submit event to re-run the search
|
|
||||||
if (lastSearchString.current) {
|
|
||||||
find({ target: { value: lastSearchString.current } } as ChangeEvent<HTMLInputElement>);
|
|
||||||
}
|
|
||||||
}, [data, find]);
|
|
||||||
|
|
||||||
return { find, select, results, error };
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -46,7 +46,6 @@ export default function TitleList({ mode }: TitleListProps) {
|
|||||||
eventData={eventData}
|
eventData={eventData}
|
||||||
selectedEventId={selectedEventId}
|
selectedEventId={selectedEventId}
|
||||||
resolvedFollowEventId={resolvedFollowEventId}
|
resolvedFollowEventId={resolvedFollowEventId}
|
||||||
rundownId={rundown.id}
|
|
||||||
/>
|
/>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -56,21 +55,14 @@ interface TitleListContentProps {
|
|||||||
eventData: ExtendedEntry<OntimeEvent>[];
|
eventData: ExtendedEntry<OntimeEvent>[];
|
||||||
selectedEventId: string | null;
|
selectedEventId: string | null;
|
||||||
resolvedFollowEventId: string | null;
|
resolvedFollowEventId: string | null;
|
||||||
rundownId: string;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function TitleListContent({
|
function TitleListContent({ mode, eventData, selectedEventId, resolvedFollowEventId }: TitleListContentProps) {
|
||||||
mode,
|
|
||||||
eventData,
|
|
||||||
selectedEventId,
|
|
||||||
resolvedFollowEventId,
|
|
||||||
rundownId,
|
|
||||||
}: TitleListContentProps) {
|
|
||||||
'use memo';
|
'use memo';
|
||||||
|
|
||||||
const virtuosoRef = useRef<VirtuosoHandle | null>(null);
|
const virtuosoRef = useRef<VirtuosoHandle | null>(null);
|
||||||
const scrollParentRef = useRef<HTMLDivElement | null>(null);
|
const scrollParentRef = useRef<HTMLDivElement | null>(null);
|
||||||
const selectAndRevealEntry = useSelectAndRevealEntry(rundownId);
|
const selectAndRevealEntry = useSelectAndRevealEntry();
|
||||||
|
|
||||||
// Calculate current event info
|
// Calculate current event info
|
||||||
const currentEventInfo = useMemo(() => {
|
const currentEventInfo = useMemo(() => {
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
import { CustomFields, OntimeEntry, ProjectData, Settings } from 'ontime-types';
|
import { CustomFields, OntimeEntry, ProjectData, Settings } from 'ontime-types';
|
||||||
|
|
||||||
import useCustomFields from '../../common/hooks-query/useCustomFields';
|
import useCustomFields from '../../common/hooks-query/useCustomFields';
|
||||||
|
import { useLoadedFlatRundownWithMetadata } from '../../common/hooks-query/useLoadedRundown';
|
||||||
import useProjectData from '../../common/hooks-query/useProjectData';
|
import useProjectData from '../../common/hooks-query/useProjectData';
|
||||||
import { useFlatRundownWithMetadata } from '../../common/hooks-query/useRundown';
|
|
||||||
import useSettings from '../../common/hooks-query/useSettings';
|
import useSettings from '../../common/hooks-query/useSettings';
|
||||||
import { ExtendedEntry } from '../../common/utils/rundownMetadata';
|
import { ExtendedEntry } from '../../common/utils/rundownMetadata';
|
||||||
import { ViewData, aggregateQueryStatus } from '../utils/viewLoader.utils';
|
import { ViewData, aggregateQueryStatus } from '../utils/viewLoader.utils';
|
||||||
@@ -16,7 +16,7 @@ export interface TimelineData {
|
|||||||
|
|
||||||
export function useTimelineData(): ViewData<TimelineData> {
|
export function useTimelineData(): ViewData<TimelineData> {
|
||||||
// HTTP API data
|
// HTTP API data
|
||||||
const { data: rundownData, status: rundownStatus } = useFlatRundownWithMetadata();
|
const { data: rundownData, status: rundownStatus } = useLoadedFlatRundownWithMetadata();
|
||||||
const { data: projectData, status: projectDataStatus } = useProjectData();
|
const { data: projectData, status: projectDataStatus } = useProjectData();
|
||||||
const { data: settings, status: settingsStatus } = useSettings();
|
const { data: settings, status: settingsStatus } = useSettings();
|
||||||
const { data: customFields, status: customFieldsStatus } = useCustomFields();
|
const { data: customFields, status: customFieldsStatus } = useCustomFields();
|
||||||
|
|||||||
@@ -195,6 +195,24 @@
|
|||||||
font-weight: 600;
|
font-weight: 600;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.sound-prompt {
|
||||||
|
position: absolute;
|
||||||
|
bottom: $view-block-padding;
|
||||||
|
left: $view-inline-padding;
|
||||||
|
padding: 0.5em 0.75em;
|
||||||
|
border-radius: $element-border-radius;
|
||||||
|
background-color: $viewer-card-bg-color;
|
||||||
|
color: $viewer-secondary-color;
|
||||||
|
font-size: $timer-label-size;
|
||||||
|
text-transform: uppercase;
|
||||||
|
pointer-events: none;
|
||||||
|
transition: opacity $viewer-transition-time;
|
||||||
|
|
||||||
|
&--hidden {
|
||||||
|
opacity: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/* =================== LOGO ===================*/
|
/* =================== LOGO ===================*/
|
||||||
.logo {
|
.logo {
|
||||||
position: absolute;
|
position: absolute;
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ import TitleCard from '../../common/components/title-card/TitleCard';
|
|||||||
import ViewLogo from '../../common/components/view-logo/ViewLogo';
|
import ViewLogo from '../../common/components/view-logo/ViewLogo';
|
||||||
import ViewParamsEditor from '../../common/components/view-params-editor/ViewParamsEditor';
|
import ViewParamsEditor from '../../common/components/view-params-editor/ViewParamsEditor';
|
||||||
import { useAutoTickingClock } from '../../common/hooks/useAutoTickingClock';
|
import { useAutoTickingClock } from '../../common/hooks/useAutoTickingClock';
|
||||||
|
import { useFadeOutOnInactivity } from '../../common/hooks/useFadeOutOnInactivity';
|
||||||
import { useTimerSocket } from '../../common/hooks/useSocket';
|
import { useTimerSocket } from '../../common/hooks/useSocket';
|
||||||
import { useWindowTitle } from '../../common/hooks/useWindowTitle';
|
import { useWindowTitle } from '../../common/hooks/useWindowTitle';
|
||||||
import { cx } from '../../common/utils/styleUtils';
|
import { cx } from '../../common/utils/styleUtils';
|
||||||
@@ -30,6 +31,7 @@ import {
|
|||||||
getTotalTime,
|
getTotalTime,
|
||||||
} from './timer.utils';
|
} from './timer.utils';
|
||||||
import { TimerData, useTimerData } from './useTimerData';
|
import { TimerData, useTimerData } from './useTimerData';
|
||||||
|
import { useTimerSound } from './useTimerSound';
|
||||||
|
|
||||||
import './Timer.scss';
|
import './Timer.scss';
|
||||||
|
|
||||||
@@ -66,6 +68,7 @@ function Timer({ customFields, projectData, isMirrored, settings, viewSettings,
|
|||||||
freezeOvertime,
|
freezeOvertime,
|
||||||
freezeMessage,
|
freezeMessage,
|
||||||
hidePhase,
|
hidePhase,
|
||||||
|
endSound,
|
||||||
font,
|
font,
|
||||||
keyColour,
|
keyColour,
|
||||||
timerColour,
|
timerColour,
|
||||||
@@ -75,6 +78,8 @@ function Timer({ customFields, projectData, isMirrored, settings, viewSettings,
|
|||||||
const { getLocalizedString } = useTranslation();
|
const { getLocalizedString } = useTranslation();
|
||||||
const localisedMinutes = getLocalizedString('common.minutes');
|
const localisedMinutes = getLocalizedString('common.minutes');
|
||||||
|
|
||||||
|
const showSoundPrompt = useTimerSound(time.phase, endSound);
|
||||||
|
|
||||||
// gather modifiers
|
// gather modifiers
|
||||||
const viewTimerType = timerType ?? timerTypeNow;
|
const viewTimerType = timerType ?? timerTypeNow;
|
||||||
const showOverlay = getShowMessage(message.timer);
|
const showOverlay = getShowMessage(message.timer);
|
||||||
@@ -156,6 +161,8 @@ function Timer({ customFields, projectData, isMirrored, settings, viewSettings,
|
|||||||
|
|
||||||
<ViewParamsEditor target={OntimeView.Timer} viewOptions={timerOptions} />
|
<ViewParamsEditor target={OntimeView.Timer} viewOptions={timerOptions} />
|
||||||
|
|
||||||
|
{showSoundPrompt && <SoundPermissionPrompt />}
|
||||||
|
|
||||||
<div className={cx(['blackout', message.timer.blackout && 'blackout--active'])} />
|
<div className={cx(['blackout', message.timer.blackout && 'blackout--active'])} />
|
||||||
|
|
||||||
{!hideMessage && (
|
{!hideMessage && (
|
||||||
@@ -227,3 +234,13 @@ function TimerAutoTickingClock({ clockFormat }: { clockFormat: MaybeString }) {
|
|||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function SoundPermissionPrompt() {
|
||||||
|
const isUserActive = useFadeOutOnInactivity(true);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className={cx(['sound-prompt', !isUserActive && 'sound-prompt--hidden'])} aria-live='polite'>
|
||||||
|
Interact with the page (click/tap or press any key) to enable sound
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,34 @@
|
|||||||
|
import { TimerPhase } from 'ontime-types';
|
||||||
|
|
||||||
|
import { shouldPlayEndSound } from '../timer.utils';
|
||||||
|
|
||||||
|
describe('shouldPlayEndSound()', () => {
|
||||||
|
test.each([TimerPhase.Default, TimerPhase.Warning, TimerPhase.Danger])(
|
||||||
|
'sounds when a running timer goes into overtime from %s',
|
||||||
|
(previousPhase) => {
|
||||||
|
expect(shouldPlayEndSound(previousPhase, TimerPhase.Overtime)).toBe(true);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
it('stays silent on the first phase we see, a client could be joining mid-overtime', () => {
|
||||||
|
expect(shouldPlayEndSound(null, TimerPhase.Overtime)).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('stays silent when the phase was reset, a reload during overtime starts from none', () => {
|
||||||
|
expect(shouldPlayEndSound(TimerPhase.None, TimerPhase.Overtime)).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('stays silent for a roll timer waiting to start', () => {
|
||||||
|
expect(shouldPlayEndSound(TimerPhase.Pending, TimerPhase.Overtime)).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('sounds once, not on every update while in overtime', () => {
|
||||||
|
expect(shouldPlayEndSound(TimerPhase.Overtime, TimerPhase.Overtime)).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('stays silent on phases which are not the end of the timer', () => {
|
||||||
|
expect(shouldPlayEndSound(TimerPhase.Default, TimerPhase.Warning)).toBe(false);
|
||||||
|
expect(shouldPlayEndSound(TimerPhase.Warning, TimerPhase.Danger)).toBe(false);
|
||||||
|
expect(shouldPlayEndSound(TimerPhase.Overtime, TimerPhase.None)).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -16,6 +16,7 @@ import { ViewOption } from '../../common/components/view-params-editor/viewParam
|
|||||||
import { makeOptionsFromCustomFields } from '../../common/components/view-params-editor/viewParams.utils';
|
import { makeOptionsFromCustomFields } from '../../common/components/view-params-editor/viewParams.utils';
|
||||||
import { PresetContext } from '../../common/context/PresetContext';
|
import { PresetContext } from '../../common/context/PresetContext';
|
||||||
import { isStringBoolean, makeColourString } from '../common/viewUtils';
|
import { isStringBoolean, makeColourString } from '../common/viewUtils';
|
||||||
|
import { endSoundOptions, isEndSound, type EndSound } from './timer.sound';
|
||||||
|
|
||||||
// manually match the properties of TimerType excluding the None
|
// manually match the properties of TimerType excluding the None
|
||||||
const timerDisplayOptions: SelectOption[] = [
|
const timerDisplayOptions: SelectOption[] = [
|
||||||
@@ -76,6 +77,15 @@ export const getTimerOptions = (timeFormat: string, customFields: CustomFields):
|
|||||||
type: 'boolean',
|
type: 'boolean',
|
||||||
defaultValue: false,
|
defaultValue: false,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
id: 'endSound',
|
||||||
|
title: 'Play sound on timer end',
|
||||||
|
description:
|
||||||
|
'Plays a sound in this screen when the timer reaches zero. The screen must be interacted with once before it can play',
|
||||||
|
type: 'option',
|
||||||
|
values: endSoundOptions,
|
||||||
|
defaultValue: 'none',
|
||||||
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -193,6 +203,7 @@ type TimerOptions = {
|
|||||||
freezeOvertime: boolean;
|
freezeOvertime: boolean;
|
||||||
freezeMessage: string;
|
freezeMessage: string;
|
||||||
hidePhase: boolean;
|
hidePhase: boolean;
|
||||||
|
endSound: EndSound;
|
||||||
font?: string;
|
font?: string;
|
||||||
keyColour?: string;
|
keyColour?: string;
|
||||||
timerColour?: string;
|
timerColour?: string;
|
||||||
@@ -208,6 +219,7 @@ function getOptionsFromParams(searchParams: URLSearchParams, defaultValues?: URL
|
|||||||
|
|
||||||
// Get timerType from either source
|
// Get timerType from either source
|
||||||
const timerType = validateTimerType(getValue('timerType'), TimerType.None);
|
const timerType = validateTimerType(getValue('timerType'), TimerType.None);
|
||||||
|
const endSoundValue = getValue('endSound');
|
||||||
|
|
||||||
return {
|
return {
|
||||||
hideClock: isStringBoolean(getValue('hideClock')),
|
hideClock: isStringBoolean(getValue('hideClock')),
|
||||||
@@ -227,6 +239,7 @@ function getOptionsFromParams(searchParams: URLSearchParams, defaultValues?: URL
|
|||||||
freezeOvertime: isStringBoolean(getValue('freezeOvertime')),
|
freezeOvertime: isStringBoolean(getValue('freezeOvertime')),
|
||||||
freezeMessage: getValue('freezeMessage') ?? '',
|
freezeMessage: getValue('freezeMessage') ?? '',
|
||||||
hidePhase: isStringBoolean(getValue('hidePhase')),
|
hidePhase: isStringBoolean(getValue('hidePhase')),
|
||||||
|
endSound: isEndSound(endSoundValue) ? endSoundValue : 'none',
|
||||||
|
|
||||||
font: getValue('font') ?? undefined,
|
font: getValue('font') ?? undefined,
|
||||||
keyColour: makeColourString(getValue('keyColour')),
|
keyColour: makeColourString(getValue('keyColour')),
|
||||||
|
|||||||
@@ -0,0 +1,20 @@
|
|||||||
|
import arpeggio from '../../assets/sounds/arpeggio.wav';
|
||||||
|
import bell from '../../assets/sounds/bell.wav';
|
||||||
|
import chime from '../../assets/sounds/chime.wav';
|
||||||
|
import type { SelectOption } from '../../common/components/select/Select';
|
||||||
|
|
||||||
|
// synthesised tones bundled with the app, no external source or licence to track
|
||||||
|
export const endSoundSources = { chime, bell, arpeggio } as const;
|
||||||
|
|
||||||
|
export type EndSound = 'none' | keyof typeof endSoundSources;
|
||||||
|
|
||||||
|
export const endSoundOptions: SelectOption[] = [
|
||||||
|
{ value: 'none', label: 'None' },
|
||||||
|
{ value: 'chime', label: 'Chime' },
|
||||||
|
{ value: 'bell', label: 'Bell' },
|
||||||
|
{ value: 'arpeggio', label: 'Arpeggio' },
|
||||||
|
];
|
||||||
|
|
||||||
|
export function isEndSound(value: string | null): value is EndSound {
|
||||||
|
return value === 'none' || value === 'chime' || value === 'bell' || value === 'arpeggio';
|
||||||
|
}
|
||||||
@@ -189,3 +189,18 @@ export function getCardData(
|
|||||||
nextSecondary,
|
nextSecondary,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the end of timer sound should play for a given phase transition
|
||||||
|
* We only sound the transition into overtime from a phase that was already counting,
|
||||||
|
* which keeps a client that connects or reloads mid-overtime silent
|
||||||
|
*/
|
||||||
|
export function shouldPlayEndSound(previousPhase: TimerPhase | null, phase: TimerPhase): boolean {
|
||||||
|
if (phase !== TimerPhase.Overtime) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
previousPhase === TimerPhase.Default || previousPhase === TimerPhase.Warning || previousPhase === TimerPhase.Danger
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
import { CustomFields, ProjectData, RundownEntries, Settings, ViewSettings } from 'ontime-types';
|
import { CustomFields, ProjectData, RundownEntries, Settings, ViewSettings } from 'ontime-types';
|
||||||
|
|
||||||
import useCustomFields from '../../common/hooks-query/useCustomFields';
|
import useCustomFields from '../../common/hooks-query/useCustomFields';
|
||||||
|
import { useLoadedRundown } from '../../common/hooks-query/useLoadedRundown';
|
||||||
import useProjectData from '../../common/hooks-query/useProjectData';
|
import useProjectData from '../../common/hooks-query/useProjectData';
|
||||||
import useRundown from '../../common/hooks-query/useRundown';
|
|
||||||
import useSettings from '../../common/hooks-query/useSettings';
|
import useSettings from '../../common/hooks-query/useSettings';
|
||||||
import useViewSettings from '../../common/hooks-query/useViewSettings';
|
import useViewSettings from '../../common/hooks-query/useViewSettings';
|
||||||
import { useViewOptionsStore } from '../../common/stores/viewOptions';
|
import { useViewOptionsStore } from '../../common/stores/viewOptions';
|
||||||
@@ -26,7 +26,7 @@ export function useTimerData(): ViewData<TimerData> {
|
|||||||
const { data: viewSettings, status: viewSettingsStatus } = useViewSettings();
|
const { data: viewSettings, status: viewSettingsStatus } = useViewSettings();
|
||||||
const { data: settings, status: settingsStatus } = useSettings();
|
const { data: settings, status: settingsStatus } = useSettings();
|
||||||
const { data: customFields, status: customFieldsStatus } = useCustomFields();
|
const { data: customFields, status: customFieldsStatus } = useCustomFields();
|
||||||
const { data: rundown, status: rundownStatus } = useRundown();
|
const { data: rundown, status: rundownStatus } = useLoadedRundown();
|
||||||
const { entries } = rundown;
|
const { entries } = rundown;
|
||||||
|
|
||||||
return {
|
return {
|
||||||
|
|||||||
@@ -0,0 +1,99 @@
|
|||||||
|
import { TimerPhase } from 'ontime-types';
|
||||||
|
import { useEffect, useRef, useState } from 'react';
|
||||||
|
|
||||||
|
import { endSoundSources, type EndSound } from './timer.sound';
|
||||||
|
import { shouldPlayEndSound } from './timer.utils';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Plays a sound when the timer reaches its end
|
||||||
|
*
|
||||||
|
* Browsers reject playback until the document has been interacted with, and that permission
|
||||||
|
* is lost on every page load. Since a timer screen is typically left unattended, we prime the
|
||||||
|
* audio element on the first interaction and let the view prompt for one if it never comes.
|
||||||
|
* Safari grants the permission per element, so priming has to call play() on this element from
|
||||||
|
* inside the event handler, it is not enough to know that an interaction happened.
|
||||||
|
*/
|
||||||
|
export function useTimerSound(phase: TimerPhase, sound: EndSound): boolean {
|
||||||
|
const audioRef = useRef<HTMLAudioElement | null>(null);
|
||||||
|
const previousPhaseRef = useRef<TimerPhase | null>(null);
|
||||||
|
const [isArmed, setIsArmed] = useState(false);
|
||||||
|
|
||||||
|
const enabled = sound !== 'none';
|
||||||
|
|
||||||
|
// Create and clean up the audio element; changing sounds requires re-arming it in Safari.
|
||||||
|
useEffect(() => {
|
||||||
|
setIsArmed(false);
|
||||||
|
|
||||||
|
if (sound === 'none') {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const audio = new Audio(endSoundSources[sound]);
|
||||||
|
audioRef.current = audio;
|
||||||
|
|
||||||
|
return () => {
|
||||||
|
audio.pause();
|
||||||
|
audioRef.current = null;
|
||||||
|
};
|
||||||
|
}, [sound]);
|
||||||
|
|
||||||
|
// Listen for user interaction until muted playback succeeds and arms the selected audio element.
|
||||||
|
useEffect(() => {
|
||||||
|
if (!enabled || isArmed) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const controller = new AbortController();
|
||||||
|
const prime = () => {
|
||||||
|
const audio = audioRef.current;
|
||||||
|
if (!audio) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const wasMuted = audio.muted;
|
||||||
|
audio.muted = true;
|
||||||
|
audio
|
||||||
|
.play()
|
||||||
|
.then(() => {
|
||||||
|
if (audioRef.current !== audio) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
audio.pause();
|
||||||
|
audio.currentTime = 0;
|
||||||
|
setIsArmed(true);
|
||||||
|
})
|
||||||
|
.catch(() => {
|
||||||
|
// playback is still blocked, a later interaction will try again
|
||||||
|
})
|
||||||
|
.finally(() => {
|
||||||
|
audio.muted = wasMuted;
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
document.addEventListener('pointerdown', prime, { capture: true, signal: controller.signal });
|
||||||
|
document.addEventListener('keydown', prime, { capture: true, signal: controller.signal });
|
||||||
|
|
||||||
|
return () => {
|
||||||
|
controller.abort();
|
||||||
|
};
|
||||||
|
}, [enabled, isArmed]);
|
||||||
|
|
||||||
|
// Track phase transitions and play only when a running timer enters overtime.
|
||||||
|
useEffect(() => {
|
||||||
|
const previousPhase = previousPhaseRef.current;
|
||||||
|
previousPhaseRef.current = phase;
|
||||||
|
|
||||||
|
if (!enabled || !shouldPlayEndSound(previousPhase, phase)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const audio = audioRef.current;
|
||||||
|
if (!audio) return;
|
||||||
|
|
||||||
|
audio.currentTime = 0;
|
||||||
|
audio.play().catch(() => {
|
||||||
|
// the screen has not been interacted with, the view shows a prompt for it
|
||||||
|
});
|
||||||
|
}, [enabled, phase]);
|
||||||
|
|
||||||
|
return enabled && !isArmed;
|
||||||
|
}
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "ontime-electron",
|
"name": "ontime-electron",
|
||||||
"version": "4.12.0",
|
"version": "4.13.0",
|
||||||
"author": "Carlos Valente",
|
"author": "Carlos Valente",
|
||||||
"description": "Time keeping for live events",
|
"description": "Time keeping for live events",
|
||||||
"repository": "https://github.com/cpvalente/ontime",
|
"repository": "https://github.com/cpvalente/ontime",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@getontime/resolver",
|
"name": "@getontime/resolver",
|
||||||
"version": "4.12.0",
|
"version": "4.13.0",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"repository": "https://github.com/cpvalente/ontime",
|
"repository": "https://github.com/cpvalente/ontime",
|
||||||
"types": "./dist/main.d.ts",
|
"types": "./dist/main.d.ts",
|
||||||
@@ -17,7 +17,7 @@
|
|||||||
"parser"
|
"parser"
|
||||||
],
|
],
|
||||||
"author": "",
|
"author": "",
|
||||||
"license": "AGPL-3.0-only",
|
"license": "ISC",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"ontime-types": "workspace:^4.2.1",
|
"ontime-types": "workspace:^4.2.1",
|
||||||
"tsdown": "^0.22.4",
|
"tsdown": "^0.22.4",
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
"name": "ontime-server",
|
"name": "ontime-server",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "src/index.ts",
|
"main": "src/index.ts",
|
||||||
"version": "4.12.0",
|
"version": "4.13.0",
|
||||||
"exports": "./src/index.js",
|
"exports": "./src/index.js",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@googleapis/sheets": "^5.0.5",
|
"@googleapis/sheets": "^5.0.5",
|
||||||
|
|||||||
@@ -1718,16 +1718,18 @@ describe('rundownMutation.swap()', () => {
|
|||||||
expect((testRundown.entries['1'] as OntimeEvent).id).toBe('1');
|
expect((testRundown.entries['1'] as OntimeEvent).id).toBe('1');
|
||||||
expect((testRundown.entries['1'] as OntimeEvent).cue).toBe('data2');
|
expect((testRundown.entries['1'] as OntimeEvent).cue).toBe('data2');
|
||||||
expect((testRundown.entries['1'] as OntimeEvent).timeStart).toBe(1);
|
expect((testRundown.entries['1'] as OntimeEvent).timeStart).toBe(1);
|
||||||
expect((testRundown.entries['1'] as OntimeEvent).revision).toBe(1);
|
// the swapped entries changed, their revision has to say so
|
||||||
|
expect((testRundown.entries['1'] as OntimeEvent).revision).toBe(2);
|
||||||
|
|
||||||
expect((testRundown.entries['2'] as OntimeEvent).id).toBe('2');
|
expect((testRundown.entries['2'] as OntimeEvent).id).toBe('2');
|
||||||
expect((testRundown.entries['2'] as OntimeEvent).cue).toBe('data1');
|
expect((testRundown.entries['2'] as OntimeEvent).cue).toBe('data1');
|
||||||
expect((testRundown.entries['2'] as OntimeEvent).timeStart).toBe(2);
|
expect((testRundown.entries['2'] as OntimeEvent).timeStart).toBe(2);
|
||||||
expect((testRundown.entries['2'] as OntimeEvent).revision).toBe(1);
|
expect((testRundown.entries['2'] as OntimeEvent).revision).toBe(2);
|
||||||
|
|
||||||
expect((testRundown.entries['3'] as OntimeEvent).id).toBe('3');
|
expect((testRundown.entries['3'] as OntimeEvent).id).toBe('3');
|
||||||
expect((testRundown.entries['3'] as OntimeEvent).cue).toBe('data3');
|
expect((testRundown.entries['3'] as OntimeEvent).cue).toBe('data3');
|
||||||
expect((testRundown.entries['3'] as OntimeEvent).timeStart).toBe(3);
|
expect((testRundown.entries['3'] as OntimeEvent).timeStart).toBe(3);
|
||||||
|
// untouched, so it keeps its revision
|
||||||
expect((testRundown.entries['3'] as OntimeEvent).revision).toBe(1);
|
expect((testRundown.entries['3'] as OntimeEvent).revision).toBe(1);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
|
import { deepEqual } from 'fast-equals';
|
||||||
import {
|
import {
|
||||||
EndAction,
|
EndAction,
|
||||||
|
OntimeEntry,
|
||||||
OntimeEvent,
|
OntimeEvent,
|
||||||
OntimeGroup,
|
OntimeGroup,
|
||||||
OntimeMilestone,
|
OntimeMilestone,
|
||||||
@@ -8,13 +10,21 @@ import {
|
|||||||
TimerType,
|
TimerType,
|
||||||
Trigger,
|
Trigger,
|
||||||
} from 'ontime-types';
|
} from 'ontime-types';
|
||||||
import { MILLIS_PER_HOUR, MILLIS_PER_MINUTE, createEvent } from 'ontime-utils';
|
import {
|
||||||
|
MILLIS_PER_HOUR,
|
||||||
|
MILLIS_PER_MINUTE,
|
||||||
|
createDelay,
|
||||||
|
createEvent,
|
||||||
|
createGroup,
|
||||||
|
createMilestone,
|
||||||
|
} from 'ontime-utils';
|
||||||
import { assertType } from 'vitest';
|
import { assertType } from 'vitest';
|
||||||
|
|
||||||
import { makeOntimeEvent, makeOntimeGroup, makeOntimeMilestone, makeRundown } from '../__mocks__/rundown.mocks.js';
|
import { makeOntimeEvent, makeOntimeGroup, makeOntimeMilestone, makeRundown } from '../__mocks__/rundown.mocks.js';
|
||||||
import { parseRundown } from '../rundown.parser.js';
|
import { parseRundown } from '../rundown.parser.js';
|
||||||
import {
|
import {
|
||||||
calculateDayOffset,
|
calculateDayOffset,
|
||||||
|
cloneEntryData,
|
||||||
deleteById,
|
deleteById,
|
||||||
doesInvalidateMetadata,
|
doesInvalidateMetadata,
|
||||||
getIntegerAndFraction,
|
getIntegerAndFraction,
|
||||||
@@ -715,3 +725,68 @@ describe('eventDurationMatchGroupTarget()', () => {
|
|||||||
expect(result).toStrictEqual(null);
|
expect(result).toStrictEqual(null);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe('cloneEntryData()', () => {
|
||||||
|
const trigger: Trigger = {
|
||||||
|
id: 'trigger-1',
|
||||||
|
title: 'Go on air',
|
||||||
|
trigger: TimerLifeCycle.onStart,
|
||||||
|
automationId: 'automation-1',
|
||||||
|
};
|
||||||
|
|
||||||
|
// the real factories, so these are complete entries exactly as the rundown holds them
|
||||||
|
const entries: [string, OntimeEntry][] = [
|
||||||
|
['event', createEvent({ custom: { sponsor: 'a value' }, triggers: [trigger] }, 'cue-1') as OntimeEvent],
|
||||||
|
['group', createGroup({ id: 'group-1', entries: ['a', 'b'], custom: { sponsor: 'a value' } })],
|
||||||
|
['milestone', createMilestone({ id: 'milestone-1', custom: { sponsor: 'a value' } })],
|
||||||
|
['delay', createDelay({ id: 'delay-1', duration: 10 })],
|
||||||
|
];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fails if any nested object or array in the clone is the same reference as the source,
|
||||||
|
* so a field added later that needs a copy of its own is caught here without the clone
|
||||||
|
* having to enumerate fields.
|
||||||
|
*/
|
||||||
|
function expectNoSharedReferences(clone: unknown, source: unknown, path: string) {
|
||||||
|
if (typeof source !== 'object' || source === null) return;
|
||||||
|
expect(clone, `${path} is shared with the source`).not.toBe(source);
|
||||||
|
const cloneRecord = clone as Record<string, unknown>;
|
||||||
|
const sourceRecord = source as Record<string, unknown>;
|
||||||
|
for (const key of Object.keys(sourceRecord)) {
|
||||||
|
expectNoSharedReferences(cloneRecord[key], sourceRecord[key], `${path}.${key}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** the two halves of the structuredClone contract: same value, no shared references */
|
||||||
|
it.each(entries)('clones a %s to the same value structuredClone would produce', (_type, entry) => {
|
||||||
|
expect(cloneEntryData(entry)).toStrictEqual(structuredClone(entry));
|
||||||
|
});
|
||||||
|
|
||||||
|
it.each(entries)('shares no nested object or array with the source %s', (_type, entry) => {
|
||||||
|
expectNoSharedReferences(cloneEntryData(entry), entry, 'entry');
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Regression: normalising an absent container to an empty one makes deepEqual report a
|
||||||
|
* change on every comparison, which would have the runtime re-broadcast and re-save the
|
||||||
|
* restore point on every tick. See PR #2178.
|
||||||
|
*/
|
||||||
|
it.each([
|
||||||
|
['event', makeOntimeEvent({ id: 'partial' })],
|
||||||
|
['group', makeOntimeGroup({ id: 'partial', entries: undefined })],
|
||||||
|
])('gives a partial %s exactly the keys structuredClone would, so it stays deep-equal', (_type, entry) => {
|
||||||
|
const clone = cloneEntryData(entry);
|
||||||
|
// asserting on keys, not values: `toBeUndefined()` cannot tell an absent key from an own
|
||||||
|
// key holding undefined, and it is key presence that decides the deepEqual below
|
||||||
|
expect(Object.keys(clone).sort()).toEqual(Object.keys(structuredClone(entry)).sort());
|
||||||
|
// this is the comparison runtime.service.ts uses to decide whether to re-broadcast an
|
||||||
|
// entry; if the clone gains a key, every tick looks like a change
|
||||||
|
expect(deepEqual(clone, entry)).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('throws on an entry type it does not know how to clone', () => {
|
||||||
|
expect(() => cloneEntryData({ id: 'x', type: 'unknown' } as unknown as OntimeEvent)).toThrow(
|
||||||
|
'Unsupported entry type for cloning',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|||||||
@@ -27,6 +27,7 @@ import {
|
|||||||
isPlayableEvent,
|
isPlayableEvent,
|
||||||
} from 'ontime-types';
|
} from 'ontime-types';
|
||||||
import { addToRundown, createGroup, customFieldLabelToKey, getInsertAfterId, insertAtIndex } from 'ontime-utils';
|
import { addToRundown, createGroup, customFieldLabelToKey, getInsertAfterId, insertAtIndex } from 'ontime-utils';
|
||||||
|
import type { DeepReadonly } from 'ts-essentials';
|
||||||
|
|
||||||
import { getDataProvider } from '../../classes/data-provider/DataProvider.js';
|
import { getDataProvider } from '../../classes/data-provider/DataProvider.js';
|
||||||
import { consoleError } from '../../utils/console.js';
|
import { consoleError } from '../../utils/console.js';
|
||||||
@@ -34,6 +35,7 @@ import { ProcessedRundownMetadata, makeRundownMetadata } from './rundown.parser.
|
|||||||
import type { RundownMetadata } from './rundown.types.js';
|
import type { RundownMetadata } from './rundown.types.js';
|
||||||
import {
|
import {
|
||||||
applyPatchToEntry,
|
applyPatchToEntry,
|
||||||
|
cloneRundown,
|
||||||
cloneSimpleRundownEntry,
|
cloneSimpleRundownEntry,
|
||||||
deleteById,
|
deleteById,
|
||||||
doesInvalidateMetadata,
|
doesInvalidateMetadata,
|
||||||
@@ -43,9 +45,14 @@ import {
|
|||||||
} from './rundown.utils.js';
|
} from './rundown.utils.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The currently loaded rundown in cache
|
* The currently loaded rundown in cache.
|
||||||
|
*
|
||||||
|
* Reassigned - never mutated in place - when a different rundown is loaded: the persistence
|
||||||
|
* layer stores this object by reference, so repurposing it for another rundown would rewrite
|
||||||
|
* the previously loaded rundown's stored record. Mutating it in place while it represents the
|
||||||
|
* same rundown (ie. from commit) is intended, and is what keeps the stored record current.
|
||||||
*/
|
*/
|
||||||
const cachedRundown: Rundown = {
|
let cachedRundown: Rundown = {
|
||||||
id: '',
|
id: '',
|
||||||
title: '',
|
title: '',
|
||||||
order: [],
|
order: [],
|
||||||
@@ -79,9 +86,16 @@ export const getRundownMetadata = (): Readonly<RundownMetadata> => rundownMetada
|
|||||||
export const getProjectCustomFields = (): Readonly<CustomFields> => projectCustomFields;
|
export const getProjectCustomFields = (): Readonly<CustomFields> => projectCustomFields;
|
||||||
export const getEntryWithId = (entryId: EntryId): OntimeEntry | undefined => cachedRundown.entries[entryId];
|
export const getEntryWithId = (entryId: EntryId): OntimeEntry | undefined => cachedRundown.entries[entryId];
|
||||||
|
|
||||||
type Transaction = {
|
/**
|
||||||
|
* @param R the type callers see for `rundown` - a plain, mutable `Rundown` when the
|
||||||
|
* transaction was opened with `mutableRundown: true`, otherwise a `DeepReadonly<Rundown>`
|
||||||
|
* so that accidentally mutating an entry (or an order array) on a non-mutable transaction
|
||||||
|
* - which would silently corrupt the live cache without going through commit() - is a
|
||||||
|
* compile-time error instead of a runtime bug.
|
||||||
|
*/
|
||||||
|
type Transaction<R> = {
|
||||||
customFields: CustomFields;
|
customFields: CustomFields;
|
||||||
rundown: Rundown;
|
rundown: R;
|
||||||
|
|
||||||
commit: (shouldProcess?: boolean) => Promise<{
|
commit: (shouldProcess?: boolean) => Promise<{
|
||||||
rundown: Readonly<Rundown>;
|
rundown: Readonly<Rundown>;
|
||||||
@@ -102,11 +116,17 @@ type TransactionOptions = {
|
|||||||
rundownId?: string;
|
rundownId?: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
export function createTransaction(options: TransactionOptions): Transaction {
|
export function createTransaction(options: TransactionOptions & { mutableRundown: true }): Transaction<Rundown>;
|
||||||
|
export function createTransaction(
|
||||||
|
options: TransactionOptions & { mutableRundown?: false },
|
||||||
|
): Transaction<DeepReadonly<Rundown>>;
|
||||||
|
export function createTransaction(
|
||||||
|
options: TransactionOptions,
|
||||||
|
): Transaction<Rundown> | Transaction<DeepReadonly<Rundown>> {
|
||||||
const targetId = options.rundownId ?? cachedRundown.id;
|
const targetId = options.rundownId ?? cachedRundown.id;
|
||||||
const isLoaded = targetId === cachedRundown.id;
|
const isLoaded = targetId === cachedRundown.id;
|
||||||
const sourceRundown: Rundown = isLoaded ? cachedRundown : (getDataProvider().getRundown(targetId) as Rundown);
|
const sourceRundown: Rundown = isLoaded ? cachedRundown : (getDataProvider().getRundown(targetId) as Rundown);
|
||||||
const rundown = options.mutableRundown ? structuredClone(sourceRundown) : sourceRundown;
|
const rundown = options.mutableRundown ? cloneRundown(sourceRundown) : sourceRundown;
|
||||||
const customFields = options.mutableCustomFields ? structuredClone(projectCustomFields) : projectCustomFields;
|
const customFields = options.mutableCustomFields ? structuredClone(projectCustomFields) : projectCustomFields;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -402,7 +422,7 @@ function swap(rundown: Rundown, eventFrom: OntimeEvent, eventTo: OntimeEvent) {
|
|||||||
gap: eventFrom.gap,
|
gap: eventFrom.gap,
|
||||||
dayOffset: eventFrom.dayOffset,
|
dayOffset: eventFrom.dayOffset,
|
||||||
// keep revision number but increment it
|
// keep revision number but increment it
|
||||||
revision: eventFrom.revision++,
|
revision: eventFrom.revision + 1,
|
||||||
};
|
};
|
||||||
|
|
||||||
rundown.entries[eventTo.id] = {
|
rundown.entries[eventTo.id] = {
|
||||||
@@ -420,7 +440,7 @@ function swap(rundown: Rundown, eventFrom: OntimeEvent, eventTo: OntimeEvent) {
|
|||||||
gap: eventTo.gap,
|
gap: eventTo.gap,
|
||||||
dayOffset: eventTo.dayOffset,
|
dayOffset: eventTo.dayOffset,
|
||||||
// keep revision number but increment it
|
// keep revision number but increment it
|
||||||
revision: eventTo.revision++,
|
revision: eventTo.revision + 1,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -707,21 +727,25 @@ export const customFieldMutation = {
|
|||||||
* Expose function to add an initial rundown to the system
|
* Expose function to add an initial rundown to the system
|
||||||
*/
|
*/
|
||||||
export function init(initialRundown: Readonly<Rundown>, initialCustomFields: Readonly<CustomFields>) {
|
export function init(initialRundown: Readonly<Rundown>, initialCustomFields: Readonly<CustomFields>) {
|
||||||
const rundown = structuredClone(initialRundown);
|
const rundown = cloneRundown(initialRundown);
|
||||||
const customFields = structuredClone(initialCustomFields);
|
const customFields = structuredClone(initialCustomFields);
|
||||||
const processedData = processRundown(rundown, customFields, { mutate: true });
|
const processedData = processRundown(rundown, customFields, { mutate: true });
|
||||||
|
|
||||||
// update the cache values
|
|
||||||
cachedRundown.id = rundown.id;
|
|
||||||
cachedRundown.title = rundown.title;
|
|
||||||
projectCustomFields = customFields;
|
projectCustomFields = customFields;
|
||||||
|
|
||||||
// eslint-disable-next-line @typescript-eslint/no-unused-vars -- we are not interested in the iteration data
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars -- we are not interested in the iteration data
|
||||||
const { previousEvent, latestEvent, previousEntry, entries, order, ...metadata } = processedData;
|
const { previousEvent, latestEvent, previousEntry, entries, order, ...metadata } = processedData;
|
||||||
cachedRundown.entries = entries;
|
|
||||||
cachedRundown.order = order;
|
// a fresh object, so that the record already stored for a previously loaded rundown keeps
|
||||||
cachedRundown.flatOrder = metadata.flatEntryOrder;
|
// pointing at that rundown's data - see the note on cachedRundown
|
||||||
cachedRundown.revision = rundown.revision;
|
cachedRundown = {
|
||||||
|
id: rundown.id,
|
||||||
|
title: rundown.title,
|
||||||
|
entries,
|
||||||
|
order,
|
||||||
|
flatOrder: metadata.flatEntryOrder,
|
||||||
|
revision: rundown.revision,
|
||||||
|
};
|
||||||
rundownMetadata = metadata;
|
rundownMetadata = metadata;
|
||||||
|
|
||||||
// defer writing to the database
|
// defer writing to the database
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ import {
|
|||||||
import { makeNewRundown } from '../../models/dataModel.js';
|
import { makeNewRundown } from '../../models/dataModel.js';
|
||||||
import type { ErrorEmitter } from '../../utils/parserUtils.js';
|
import type { ErrorEmitter } from '../../utils/parserUtils.js';
|
||||||
import { RundownMetadata } from './rundown.types.js';
|
import { RundownMetadata } from './rundown.types.js';
|
||||||
import { calculateDayOffset, cleanupCustomFields } from './rundown.utils.js';
|
import { calculateDayOffset, cleanupCustomFields, cloneEntryData } from './rundown.utils.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parse a rundowns object along with the project custom fields
|
* Parse a rundowns object along with the project custom fields
|
||||||
@@ -234,7 +234,7 @@ export function makeRundownMetadata(customFields: CustomFields, options?: { muta
|
|||||||
};
|
};
|
||||||
|
|
||||||
function process<T extends OntimeEntry>(entry: T, childOfGroup: EntryId | null): T {
|
function process<T extends OntimeEntry>(entry: T, childOfGroup: EntryId | null): T {
|
||||||
return processEntry(rundownMeta, customFields, mutate ? entry : structuredClone(entry), childOfGroup);
|
return processEntry(rundownMeta, customFields, mutate ? entry : cloneEntryData(entry), childOfGroup);
|
||||||
}
|
}
|
||||||
|
|
||||||
function getMetadata(): ProcessedRundownMetadata {
|
function getMetadata(): ProcessedRundownMetadata {
|
||||||
|
|||||||
@@ -39,6 +39,7 @@ import {
|
|||||||
import { parseRundown } from './rundown.parser.js';
|
import { parseRundown } from './rundown.parser.js';
|
||||||
import type { RundownMetadata } from './rundown.types.js';
|
import type { RundownMetadata } from './rundown.types.js';
|
||||||
import {
|
import {
|
||||||
|
cloneRundown,
|
||||||
generateEvent,
|
generateEvent,
|
||||||
getFirstInsertId,
|
getFirstInsertId,
|
||||||
getIntegerAndFraction,
|
getIntegerAndFraction,
|
||||||
@@ -626,7 +627,7 @@ export async function editCustomField(
|
|||||||
// ... reassign references in the background rundowns
|
// ... reassign references in the background rundowns
|
||||||
for (const rundownId of Object.keys(projectRundowns)) {
|
for (const rundownId of Object.keys(projectRundowns)) {
|
||||||
if (rundownId !== rundown.id) {
|
if (rundownId !== rundown.id) {
|
||||||
const backgroundRundown = structuredClone(projectRundowns[rundownId]);
|
const backgroundRundown = cloneRundown(projectRundowns[rundownId]);
|
||||||
customFieldMutation.renameUsages(backgroundRundown, oldKey, newKey);
|
customFieldMutation.renameUsages(backgroundRundown, oldKey, newKey);
|
||||||
await updateBackgroundRundown(rundownId, backgroundRundown);
|
await updateBackgroundRundown(rundownId, backgroundRundown);
|
||||||
}
|
}
|
||||||
@@ -666,7 +667,7 @@ export async function deleteCustomField(key: CustomFieldKey, projectRundowns: Pr
|
|||||||
// remove references in the background rundowns
|
// remove references in the background rundowns
|
||||||
for (const rundownId of Object.keys(projectRundowns)) {
|
for (const rundownId of Object.keys(projectRundowns)) {
|
||||||
if (rundownId !== rundown.id) {
|
if (rundownId !== rundown.id) {
|
||||||
const backgroundRundown = structuredClone(projectRundowns[rundownId]);
|
const backgroundRundown = cloneRundown(projectRundowns[rundownId]);
|
||||||
customFieldMutation.removeUsages(backgroundRundown, key);
|
customFieldMutation.removeUsages(backgroundRundown, key);
|
||||||
await updateBackgroundRundown(rundownId, backgroundRundown);
|
await updateBackgroundRundown(rundownId, backgroundRundown);
|
||||||
}
|
}
|
||||||
@@ -815,27 +816,23 @@ export async function createNewRundown(title: string) {
|
|||||||
* @throws if the provided id does not exist
|
* @throws if the provided id does not exist
|
||||||
*/
|
*/
|
||||||
export async function renameRundown(id: string, title: string) {
|
export async function renameRundown(id: string, title: string) {
|
||||||
const dataProvider = getDataProvider();
|
const { rundown, commit } = createTransaction({ rundownId: id, mutableRundown: true });
|
||||||
const rundown = dataProvider.getRundown(id);
|
|
||||||
|
|
||||||
await dataProvider.setRundown(id, { ...rundown, title, revision: rundown.revision + 1 });
|
if (rundown.title === title) {
|
||||||
|
return getDataProvider().getProjectRundowns();
|
||||||
/**
|
|
||||||
* If we are modifying the loaded rundown we re-init it
|
|
||||||
* This is likely over-kill but the simplest way to ensure state consistency
|
|
||||||
*/
|
|
||||||
if (isCurrentRundown(id)) {
|
|
||||||
const rundown = dataProvider.getRundown(id);
|
|
||||||
const customField = dataProvider.getCustomFields();
|
|
||||||
// init rundown does its own refetch
|
|
||||||
await initRundown(rundown, customField);
|
|
||||||
} else {
|
|
||||||
setImmediate(() => {
|
|
||||||
sendRefetch(RefetchKey.ProjectRundowns);
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return dataProvider.getProjectRundowns();
|
rundown.title = title;
|
||||||
|
|
||||||
|
// a title has no bearing on the schedule, there is nothing to process and no runtime to notify
|
||||||
|
const { rundownMetadata, revision } = await commit(false);
|
||||||
|
|
||||||
|
setImmediate(() => {
|
||||||
|
notifyChanges(id, rundownMetadata, revision, { external: true });
|
||||||
|
sendRefetch(RefetchKey.ProjectRundowns);
|
||||||
|
});
|
||||||
|
|
||||||
|
return getDataProvider().getProjectRundowns();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -846,7 +843,7 @@ export async function duplicateExistingRundown(id: string) {
|
|||||||
const dataProvider = getDataProvider();
|
const dataProvider = getDataProvider();
|
||||||
const rundown = dataProvider.getRundown(id);
|
const rundown = dataProvider.getRundown(id);
|
||||||
|
|
||||||
const duplicatedRundown: Rundown = structuredClone(rundown);
|
const duplicatedRundown: Rundown = cloneRundown(rundown);
|
||||||
duplicatedRundown.id = generateId();
|
duplicatedRundown.id = generateId();
|
||||||
duplicatedRundown.title = `Copy of ${rundown.title}`;
|
duplicatedRundown.title = `Copy of ${rundown.title}`;
|
||||||
duplicatedRundown.revision = 0;
|
duplicatedRundown.revision = 0;
|
||||||
|
|||||||
@@ -329,7 +329,7 @@ export function mergeRundownPreservingFields(
|
|||||||
const structure = isOntimeGroup(incomingEntry)
|
const structure = isOntimeGroup(incomingEntry)
|
||||||
? { entries: incomingEntry.entries }
|
? { entries: incomingEntry.entries }
|
||||||
: { parent: incomingEntry.parent };
|
: { parent: incomingEntry.parent };
|
||||||
entries[id] = structuredClone({ ...merged, ...structure });
|
entries[id] = cloneEntryData({ ...merged, ...structure });
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
@@ -499,6 +499,61 @@ export function cloneSimpleRundownEntry(entry: OntimeEntry, newId: EntryId): Ont
|
|||||||
throw new Error(`Unsupported entry type for cloning: ${entry}`);
|
throw new Error(`Unsupported entry type for cloning: ${entry}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fast, shape-aware clone of a single entry, preserving its identity (id, revision, etc).
|
||||||
|
* Drop-in replacement for `structuredClone(entry)`
|
||||||
|
*/
|
||||||
|
export function cloneEntryData<T extends OntimeEntry>(entry: T): T {
|
||||||
|
switch (entry.type) {
|
||||||
|
case SupportedEntry.Event: {
|
||||||
|
const clone: OntimeEvent = { ...entry };
|
||||||
|
if (clone.custom) clone.custom = { ...clone.custom };
|
||||||
|
if (clone.triggers) clone.triggers = clone.triggers.map((trigger) => ({ ...trigger }));
|
||||||
|
return clone as T;
|
||||||
|
}
|
||||||
|
case SupportedEntry.Group: {
|
||||||
|
const clone: OntimeGroup = { ...entry };
|
||||||
|
if (clone.custom) clone.custom = { ...clone.custom };
|
||||||
|
if (clone.entries) clone.entries = clone.entries.slice();
|
||||||
|
return clone as T;
|
||||||
|
}
|
||||||
|
case SupportedEntry.Milestone: {
|
||||||
|
const clone: OntimeMilestone = { ...entry };
|
||||||
|
if (clone.custom) clone.custom = { ...clone.custom };
|
||||||
|
return clone as T;
|
||||||
|
}
|
||||||
|
case SupportedEntry.Delay:
|
||||||
|
return { ...entry } as T;
|
||||||
|
default: {
|
||||||
|
// exhaustiveness guard: a new member of `SupportedEntry` is named in the error here
|
||||||
|
const unhandled: never = entry;
|
||||||
|
throw new Error(`Unsupported entry type for cloning: ${(unhandled as OntimeEntry).type}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fast, shape-aware clone of a whole rundown.
|
||||||
|
* Drop-in replacement for `structuredClone(rundown)`: every entry (and its nested
|
||||||
|
* `custom` / `triggers` / `entries` containers) gets its own copy, so callers can mutate
|
||||||
|
* the result freely without touching the source - same contract as structuredClone,
|
||||||
|
* at a fraction of the cost since we skip the generic serialization algorithm.
|
||||||
|
*/
|
||||||
|
export function cloneRundown(rundown: Readonly<Rundown>): Rundown {
|
||||||
|
const entries: RundownEntries = {};
|
||||||
|
for (const id in rundown.entries) {
|
||||||
|
entries[id] = cloneEntryData(rundown.entries[id]);
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
id: rundown.id,
|
||||||
|
title: rundown.title,
|
||||||
|
revision: rundown.revision,
|
||||||
|
order: rundown.order.slice(),
|
||||||
|
flatOrder: rundown.flatOrder.slice(),
|
||||||
|
entries,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Utility for calculating if the current events should have a day offset
|
* Utility for calculating if the current events should have a day offset
|
||||||
* @param current the current event under test
|
* @param current the current event under test
|
||||||
|
|||||||
@@ -464,9 +464,8 @@ export async function upload(sheetId: string, options: ImportMap) {
|
|||||||
sheetOrder.forEach((entryId, index) => {
|
sheetOrder.forEach((entryId, index) => {
|
||||||
const isGroupEnd = entryId.startsWith('group-end-');
|
const isGroupEnd = entryId.startsWith('group-end-');
|
||||||
const id = isGroupEnd ? entryId.split('group-end-')[1] : entryId;
|
const id = isGroupEnd ? entryId.split('group-end-')[1] : entryId;
|
||||||
const entry = isGroupEnd
|
// cellRequestFromEvent only reads the entry to build a cell request, no clone is needed
|
||||||
? ({ id: entryId, type: SupportedEntry.Group } as OntimeGroup)
|
const entry = isGroupEnd ? ({ id: entryId, type: SupportedEntry.Group } as OntimeGroup) : rundown.entries[id];
|
||||||
: structuredClone(rundown.entries[id]);
|
|
||||||
updateRundown.push(cellRequestFromEvent(entry, index, worksheetId, sheetMetadata));
|
updateRundown.push(cellRequestFromEvent(entry, index, worksheetId, sheetMetadata));
|
||||||
});
|
});
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
|
|||||||
@@ -101,8 +101,16 @@ function getCustomFields(): Readonly<CustomFields> {
|
|||||||
return db.data.customFields;
|
return db.data.customFields;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stores a rundown, replacing any existing entry for the same key.
|
||||||
|
* Takes ownership of `newData` and stores it by reference - the caller must not mutate it
|
||||||
|
* afterward. Every call site either hands over a freshly-built object it never touches again,
|
||||||
|
* or (for the loaded rundown) the cache's own long-lived object, which is already the single
|
||||||
|
* source of truth for that data - aliasing it here costs nothing and avoids a second full
|
||||||
|
* deep copy of the rundown on every commit.
|
||||||
|
*/
|
||||||
async function setRundown(rundownKey: string, newData: Rundown): ReadonlyPromise<ProjectRundowns> {
|
async function setRundown(rundownKey: string, newData: Rundown): ReadonlyPromise<ProjectRundowns> {
|
||||||
db.data.rundowns[rundownKey] = structuredClone(newData);
|
db.data.rundowns[rundownKey] = newData;
|
||||||
await persist();
|
await persist();
|
||||||
return db.data.rundowns;
|
return db.data.rundowns;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,12 +4,17 @@ import { DatabaseModel } from 'ontime-types';
|
|||||||
* Merges a partial ontime project into a given ontime project
|
* Merges a partial ontime project into a given ontime project
|
||||||
*/
|
*/
|
||||||
export function safeMerge(existing: DatabaseModel, newData: Partial<DatabaseModel>): DatabaseModel {
|
export function safeMerge(existing: DatabaseModel, newData: Partial<DatabaseModel>): DatabaseModel {
|
||||||
const deepExisting = structuredClone(existing);
|
// rundowns are merged separately below by reference (only the top-level map is copied,
|
||||||
const deepNewData = structuredClone(newData);
|
// same as the other properties here) - deep-cloning them here would be wasted work,
|
||||||
|
// since a project's rundowns are by far the largest part of this object
|
||||||
|
const { rundowns: existingRundowns, ...existingRest } = existing;
|
||||||
|
const { rundowns: newRundowns = {}, ...newDataRest } = newData;
|
||||||
|
|
||||||
|
const deepExisting = structuredClone(existingRest);
|
||||||
|
const deepNewData = structuredClone(newDataRest);
|
||||||
|
|
||||||
// destructure each property to simplify merging not provided ie: ...{} has no effect
|
// destructure each property to simplify merging not provided ie: ...{} has no effect
|
||||||
const {
|
const {
|
||||||
rundowns = {},
|
|
||||||
project = {},
|
project = {},
|
||||||
settings = {},
|
settings = {},
|
||||||
viewSettings = {},
|
viewSettings = {},
|
||||||
@@ -19,7 +24,7 @@ export function safeMerge(existing: DatabaseModel, newData: Partial<DatabaseMode
|
|||||||
} = deepNewData;
|
} = deepNewData;
|
||||||
|
|
||||||
return {
|
return {
|
||||||
rundowns: { ...existing.rundowns, ...rundowns },
|
rundowns: { ...existingRundowns, ...newRundowns },
|
||||||
project: { ...deepExisting.project, ...project },
|
project: { ...deepExisting.project, ...project },
|
||||||
settings: { ...deepExisting.settings, ...settings },
|
settings: { ...deepExisting.settings, ...settings },
|
||||||
viewSettings: { ...deepExisting.viewSettings, ...viewSettings },
|
viewSettings: { ...deepExisting.viewSettings, ...viewSettings },
|
||||||
|
|||||||
@@ -20,6 +20,7 @@ import { triggerAutomations } from '../../api-data/automation/automation.service
|
|||||||
import { triggerReportEntry } from '../../api-data/report/report.service.js';
|
import { triggerReportEntry } from '../../api-data/report/report.service.js';
|
||||||
import { getCurrentRundown, getEntryWithId, getRundownMetadata } from '../../api-data/rundown/rundown.dao.js';
|
import { getCurrentRundown, getEntryWithId, getRundownMetadata } from '../../api-data/rundown/rundown.dao.js';
|
||||||
import { RundownMetadata } from '../../api-data/rundown/rundown.types.js';
|
import { RundownMetadata } from '../../api-data/rundown/rundown.types.js';
|
||||||
|
import { cloneEntryData } from '../../api-data/rundown/rundown.utils.js';
|
||||||
import { logger } from '../../classes/Logger.js';
|
import { logger } from '../../classes/Logger.js';
|
||||||
import { timerConfig } from '../../setup/config.js';
|
import { timerConfig } from '../../setup/config.js';
|
||||||
import { eventStore } from '../../stores/EventStore.js';
|
import { eventStore } from '../../stores/EventStore.js';
|
||||||
@@ -754,7 +755,7 @@ function broadcastResult(_target: any, _propertyKey: string, descriptor: Propert
|
|||||||
}
|
}
|
||||||
// at this point we know that either the id or the contents has changed
|
// at this point we know that either the id or the contents has changed
|
||||||
batch.add(key, currentEntry as RuntimeStore[K]); // we know that there is the necessary overlap in the types to cast this
|
batch.add(key, currentEntry as RuntimeStore[K]); // we know that there is the necessary overlap in the types to cast this
|
||||||
RuntimeService.previousState[key] = structuredClone(currentEntry);
|
RuntimeService.previousState[key] = currentEntry ? cloneEntryData(currentEntry) : null;
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -36,6 +36,10 @@ Remove comments that:
|
|||||||
|
|
||||||
Update adjacent comments with code. Stale comments are defects.
|
Update adjacent comments with code. Stale comments are defects.
|
||||||
|
|
||||||
|
Add a short comment immediately above every React `useEffect` describing the external synchronization or lifecycle
|
||||||
|
responsibility it owns. Explain non-obvious reasons or constraints when they matter; for files with multiple effects, a
|
||||||
|
brief responsibility label is useful even when the mechanics are straightforward.
|
||||||
|
|
||||||
## Naming and types
|
## Naming and types
|
||||||
|
|
||||||
- Prefer Ontime terms over vague `data`, `result`, `item`.
|
- Prefer Ontime terms over vague `data`, `result`, `item`.
|
||||||
|
|||||||
@@ -9,6 +9,10 @@ Load only for touched domains. Add only stable, recurring invariants; not one-of
|
|||||||
- Preserve entry identity and supported types across patch, clone, group, ungroup, reorder.
|
- Preserve entry identity and supported types across patch, clone, group, ungroup, reorder.
|
||||||
- Distinguish loaded vs background rundown. Prefer explicit rundown ID over global current state.
|
- Distinguish loaded vs background rundown. Prefer explicit rundown ID over global current state.
|
||||||
- No caller-owned rundown mutation unless explicitly contracted.
|
- No caller-owned rundown mutation unless explicitly contracted.
|
||||||
|
- Revisions mark change: a rundown revision advances on every commit, an entry revision on every
|
||||||
|
change to that entry. Delays carry no revision. Optimistic client updates apply the same bump the
|
||||||
|
server does, so an unchanged entry keeps its identity and clients can compare revisions to tell
|
||||||
|
what moved on.
|
||||||
|
|
||||||
## Persistence, realtime, cache
|
## Persistence, realtime, cache
|
||||||
|
|
||||||
|
|||||||
@@ -222,15 +222,57 @@ test('Delete event', async ({ page }) => {
|
|||||||
await expect(page.getByRole('button', { name: 'Create Group' })).toBeVisible();
|
await expect(page.getByRole('button', { name: 'Create Group' })).toBeVisible();
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Find in rundown', async ({ page }) => {
|
test('Finder searches the rundown and reveals a result', async ({ page }) => {
|
||||||
await page.goto('/rundown');
|
await page.goto('/rundown');
|
||||||
await expect(page.getByTestId('panel-rundown')).toBeVisible();
|
await page.getByRole('button', { name: 'Edit' }).click();
|
||||||
|
|
||||||
|
// clear rundown
|
||||||
|
await page.getByRole('button', { name: 'Rundown menu' }).click();
|
||||||
|
await page.getByRole('menuitem', { name: 'Clear all' }).click();
|
||||||
|
await page.getByRole('button', { name: 'Delete all' }).click();
|
||||||
|
await expect(page.getByTestId('rundown-event')).toHaveCount(0);
|
||||||
|
|
||||||
|
// two events, where the one we are looking for is identified only by its note
|
||||||
|
await page.getByRole('button', { name: 'Create Event' }).click();
|
||||||
|
await expect(page.getByTestId('rundown-event')).toHaveCount(1);
|
||||||
|
await page.getByTestId('entry-1').click();
|
||||||
|
await page.getByTestId('entry__title').press('Escape');
|
||||||
|
await page.getByTestId('rundown-event').locator('div').filter({ hasText: '1' }).press('Alt+E');
|
||||||
|
await expect(page.getByTestId('rundown-event')).toHaveCount(2);
|
||||||
|
|
||||||
|
await page.getByTestId('entry-1').getByTestId('entry__title').fill('opening');
|
||||||
|
await page.getByTestId('entry-1').getByTestId('entry__title').press('Enter');
|
||||||
|
await page.getByTestId('entry-2').getByTestId('entry__title').fill('closing');
|
||||||
|
await page.getByTestId('entry-2').getByTestId('entry__title').press('Enter');
|
||||||
|
|
||||||
|
await page.getByTestId('entry-2').click();
|
||||||
|
await page.getByLabel('Note', { exact: true }).fill('remember the zebrafish');
|
||||||
|
await page.getByLabel('Note', { exact: true }).press('Tab');
|
||||||
|
|
||||||
|
// the shortcut has to work from a focused field, which is where it is usually reached for
|
||||||
|
await page.getByTestId('entry-2').getByTestId('entry__title').click();
|
||||||
await page.keyboard.press('ControlOrMeta+f');
|
await page.keyboard.press('ControlOrMeta+f');
|
||||||
await expect(page.getByPlaceholder('Search...')).toBeVisible();
|
await expect(page.getByPlaceholder('Search...')).toBeFocused();
|
||||||
|
|
||||||
await page.keyboard.press('Escape');
|
// a bare query reaches the note, and the result names the field it matched
|
||||||
|
await page.getByPlaceholder('Search...').fill('zebrafish');
|
||||||
|
await expect(page.getByTestId('finder-result')).toHaveCount(1);
|
||||||
|
await expect(page.getByTestId('finder-result-match')).toContainText('Note');
|
||||||
|
|
||||||
|
// a badge scopes the search to one field, without putting syntax in the input
|
||||||
|
const titleFilter = page.getByTestId('finder-filters').getByRole('button', { name: 'Title', exact: true });
|
||||||
|
await titleFilter.click();
|
||||||
|
await expect(page.getByPlaceholder('Search...')).toHaveValue('zebrafish');
|
||||||
|
await expect(page.getByTestId('finder-result')).toHaveCount(0);
|
||||||
|
|
||||||
|
// pressing it again searches every field once more
|
||||||
|
await titleFilter.click();
|
||||||
|
await expect(page.getByTestId('finder-result')).toHaveCount(1);
|
||||||
|
|
||||||
|
// choosing a result closes the finder and selects the entry in the rundown
|
||||||
|
await page.getByPlaceholder('Search...').press('Enter');
|
||||||
await expect(page.getByPlaceholder('Search...')).toBeHidden();
|
await expect(page.getByPlaceholder('Search...')).toBeHidden();
|
||||||
|
await expect(page.getByTestId('entry-2').getByTestId('rundown-event')).toHaveAttribute('data-selected', 'true');
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Open settings', async ({ page }) => {
|
test('Open settings', async ({ page }) => {
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "ontime",
|
"name": "ontime",
|
||||||
"version": "4.12.0",
|
"version": "4.13.0",
|
||||||
"description": "Time keeping for live events",
|
"description": "Time keeping for live events",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"ontime",
|
"ontime",
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"version": "4.12.0",
|
"version": "4.13.0",
|
||||||
"name": "ontime-types",
|
"name": "ontime-types",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "./src/index.ts",
|
"main": "./src/index.ts",
|
||||||
|
|||||||
Reference in New Issue
Block a user