mirror of
https://github.com/cpvalente/ontime.git
synced 2026-09-10 08:39:34 +00:00
refactor(rundown): resolve rundown data from a scope context
The editor and cuesheet had three overlapping notions of which rundown they were showing: loaded-only data hooks, a prop-drilled RundownSource, and a selection store which read the loaded rundown out of the query cache. Rendering two rundowns at once was not possible. Introduce a rundown scope: a context carrying the rundown identity (id, isLoaded and a selection store) which the utility hooks read from. useRundown, useEntry and friends keep their signatures and call sites, they simply resolve their rundown from the enclosing scope. The app mounts a scope at the root which follows the loaded rundown, so runtime views are unaffected; the editor and cuesheet mount an editable scope which also binds entry actions to the same rundown. - useEventSelection becomes a per-scope store factory, so panels hold independent cursors and the store is handed its rundown instead of reaching for the loaded one - the cuesheet selection is generalised to useRundownSelection with a namespace, so each surface persists its own choice - the clipboard records the rundown an entry was copied from, leaving room for pasting across rundowns - removes useScopedRundown and the prop-drilled RundownSource Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011a5cbVjNC5XXF88b2PkUCa
This commit is contained in:
@@ -9,6 +9,7 @@ import AppRouter from './AppRouter';
|
|||||||
import ErrorBoundary from './common/components/error-boundary/ErrorBoundary';
|
import ErrorBoundary from './common/components/error-boundary/ErrorBoundary';
|
||||||
import IdentifyOverlay from './common/components/identify-overlay/IdentifyOverlay';
|
import IdentifyOverlay from './common/components/identify-overlay/IdentifyOverlay';
|
||||||
import { AppContextProvider } from './common/context/AppContext';
|
import { AppContextProvider } from './common/context/AppContext';
|
||||||
|
import { RundownScopeProvider } from './common/context/RundownScopeContext';
|
||||||
import { ontimeQueryClient } from './common/queryClient';
|
import { ontimeQueryClient } from './common/queryClient';
|
||||||
import { connectSocket } from './common/utils/socket';
|
import { connectSocket } from './common/utils/socket';
|
||||||
import { baseURI } from './externals';
|
import { baseURI } from './externals';
|
||||||
@@ -28,7 +29,10 @@ function App() {
|
|||||||
<TranslationProvider>
|
<TranslationProvider>
|
||||||
<IdentifyOverlay />
|
<IdentifyOverlay />
|
||||||
<KeepAwake />
|
<KeepAwake />
|
||||||
<AppRouter />
|
{/* the app follows the loaded rundown, panels nest a scope to point elsewhere */}
|
||||||
|
<RundownScopeProvider rundownId={null}>
|
||||||
|
<AppRouter />
|
||||||
|
</RundownScopeProvider>
|
||||||
</TranslationProvider>
|
</TranslationProvider>
|
||||||
</ErrorBoundary>
|
</ErrorBoundary>
|
||||||
<ReactQueryDevtools initialIsOpen={false} />
|
<ReactQueryDevtools initialIsOpen={false} />
|
||||||
|
|||||||
@@ -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>
|
||||||
}
|
}
|
||||||
/>
|
/>
|
||||||
|
|||||||
@@ -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,76 @@
|
|||||||
|
import { Rundown } from 'ontime-types';
|
||||||
|
import { PropsWithChildren, createContext, useContext, useEffect, useMemo, useRef } from 'react';
|
||||||
|
|
||||||
|
import { getRundownQueryKey } 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: string | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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);
|
||||||
|
targetIdRef.current = targetId;
|
||||||
|
|
||||||
|
const selectionStoreRef = useRef<EventSelectionStoreApi | null>(null);
|
||||||
|
if (selectionStoreRef.current === null) {
|
||||||
|
selectionStoreRef.current = createEventSelectionStore(() =>
|
||||||
|
ontimeQueryClient.getQueryData<Rundown>(getRundownQueryKey(targetIdRef.current)),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const selectionStore = selectionStoreRef.current;
|
||||||
|
|
||||||
|
// a selection refers to entries of a single rundown, it cannot survive a change of target
|
||||||
|
useEffect(() => {
|
||||||
|
selectionStore.getState().clearSelectedEvents();
|
||||||
|
}, [selectionStore, targetId]);
|
||||||
|
|
||||||
|
const value = useMemo(
|
||||||
|
(): RundownScopeValue => ({
|
||||||
|
rundownId: targetId,
|
||||||
|
isLoaded: 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;
|
||||||
|
}
|
||||||
@@ -5,9 +5,9 @@ import { useEffect, useMemo } from 'react';
|
|||||||
import { queryRefetchIntervalSlow } from '../../ontimeConfig';
|
import { queryRefetchIntervalSlow } from '../../ontimeConfig';
|
||||||
import { CURRENT_RUNDOWN_QUERY_KEY, getRundownQueryKey } from '../api/constants';
|
import { CURRENT_RUNDOWN_QUERY_KEY, getRundownQueryKey } from '../api/constants';
|
||||||
import { fetchCurrentRundown, fetchRundown } from '../api/rundown';
|
import { fetchCurrentRundown, fetchRundown } from '../api/rundown';
|
||||||
|
import { useRundownScope } from '../context/RundownScopeContext';
|
||||||
import { useSelectedEventId } from '../hooks/useSocket';
|
import { useSelectedEventId } from '../hooks/useSocket';
|
||||||
import { ExtendedEntry, getFlatRundownMetadata, getRundownMetadata } from '../utils/rundownMetadata';
|
import { ExtendedEntry, getFlatRundownMetadata, getRundownMetadata } from '../utils/rundownMetadata';
|
||||||
import { useProjectRundowns } from './useProjectRundowns';
|
|
||||||
|
|
||||||
// revision is -1 so that the remote revision is higher
|
// revision is -1 so that the remote revision is higher
|
||||||
const cachedRundownPlaceholder: Rundown = {
|
const cachedRundownPlaceholder: Rundown = {
|
||||||
@@ -20,42 +20,60 @@ const cachedRundownPlaceholder: Rundown = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Normalised rundown data for the currently loaded rundown.
|
* Provides access to a specific rundown by ID.
|
||||||
*
|
*
|
||||||
* Bootstraps via the `/current` alias so the first paint is a single round-trip,
|
* Without an ID we do not yet know which rundown is loaded, so we bootstrap via
|
||||||
* independent of the project rundown list. Once the loaded id is known, the
|
* the `/current` alias to keep the first paint to a single round-trip, then seed
|
||||||
* query key swaps to the id-keyed cache that is shared with `useRundownById`.
|
* the id-keyed cache that every other reader shares.
|
||||||
*/
|
*/
|
||||||
export default function useRundown() {
|
export function useRundownById(rundownId: string | null | undefined) {
|
||||||
const queryClient = useQueryClient();
|
const queryClient = useQueryClient();
|
||||||
const {
|
const id = rundownId ?? '';
|
||||||
data: { loaded: loadedRundownId },
|
const isBootstrap = id === '';
|
||||||
} = useProjectRundowns();
|
|
||||||
|
|
||||||
const { data, status, isError, refetch, isFetching } = useQuery<Rundown>({
|
const { data, status, isError, refetch, isFetching } = useQuery<Rundown>({
|
||||||
queryKey: loadedRundownId ? getRundownQueryKey(loadedRundownId) : CURRENT_RUNDOWN_QUERY_KEY,
|
queryKey: isBootstrap ? CURRENT_RUNDOWN_QUERY_KEY : getRundownQueryKey(id),
|
||||||
queryFn: ({ signal }) => fetchCurrentRundown({ signal }),
|
queryFn: ({ signal }) => (isBootstrap ? fetchCurrentRundown({ signal }) : fetchRundown(id, { signal })),
|
||||||
|
placeholderData: (previousData, _previousQuery) => previousData,
|
||||||
refetchInterval: queryRefetchIntervalSlow,
|
refetchInterval: queryRefetchIntervalSlow,
|
||||||
});
|
});
|
||||||
|
|
||||||
// Seed the id-keyed cache when fetching via the bootstrap alias
|
// Seed the id-keyed cache when fetching via the bootstrap alias
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
if (!data || loadedRundownId) return;
|
if (!data || !isBootstrap) return;
|
||||||
queryClient.setQueryData(getRundownQueryKey(data.id), data);
|
queryClient.setQueryData(getRundownQueryKey(data.id), data);
|
||||||
}, [data, loadedRundownId, queryClient]);
|
}, [data, isBootstrap, queryClient]);
|
||||||
|
|
||||||
// Once we have the ID, drop the temporary current cache
|
// Once we have the ID, drop the temporary current cache
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
if (!loadedRundownId) return;
|
if (isBootstrap) return;
|
||||||
queryClient.removeQueries({ queryKey: CURRENT_RUNDOWN_QUERY_KEY, exact: true });
|
queryClient.removeQueries({ queryKey: CURRENT_RUNDOWN_QUERY_KEY, exact: true });
|
||||||
}, [loadedRundownId, queryClient]);
|
}, [isBootstrap, queryClient]);
|
||||||
|
|
||||||
return { data: data ?? cachedRundownPlaceholder, status, isError, refetch, isFetching };
|
return { data: data ?? cachedRundownPlaceholder, status, isError, refetch, isFetching };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Normalised rundown data for the rundown of the enclosing scope
|
||||||
|
*/
|
||||||
|
export default function useRundown() {
|
||||||
|
const { rundownId } = useRundownScope();
|
||||||
|
return useRundownById(rundownId);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Runtime state only describes the loaded rundown,
|
||||||
|
* a scope pointed elsewhere must not show a playing event
|
||||||
|
*/
|
||||||
|
export function useScopedSelectedEventId(): EntryId | null {
|
||||||
|
const { isLoaded } = useRundownScope();
|
||||||
|
const selectedEventId = useSelectedEventId();
|
||||||
|
return isLoaded ? selectedEventId : null;
|
||||||
|
}
|
||||||
|
|
||||||
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]);
|
const rundownMetadata = useMemo(() => getRundownMetadata(data, selectedEventId), [data, selectedEventId]);
|
||||||
return { data, status, rundownMetadata };
|
return { data, status, rundownMetadata };
|
||||||
}
|
}
|
||||||
@@ -79,7 +97,7 @@ export function useFlatRundown() {
|
|||||||
|
|
||||||
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 rundownWithMetadata = useMemo(() => getFlatRundownMetadata(data, selectedEventId), [data, selectedEventId]);
|
||||||
return { data: rundownWithMetadata, status };
|
return { data: rundownWithMetadata, status };
|
||||||
@@ -119,21 +137,3 @@ export function useRundownAuxData() {
|
|||||||
}, [data]);
|
}, [data]);
|
||||||
return { data: filteredData, status };
|
return { data: filteredData, status };
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Provides access to a specific rundown by ID.
|
|
||||||
* When rundownId is null/undefined the query is disabled and returns the placeholder.
|
|
||||||
*/
|
|
||||||
export function useRundownById(rundownId: string | null | undefined) {
|
|
||||||
const enabled = Boolean(rundownId);
|
|
||||||
|
|
||||||
const { data, status, isError, refetch, isFetching } = useQuery<Rundown>({
|
|
||||||
queryKey: getRundownQueryKey(rundownId ?? ''),
|
|
||||||
queryFn: ({ signal }) => fetchRundown(rundownId!, { signal }),
|
|
||||||
enabled,
|
|
||||||
placeholderData: (previousData, _previousQuery) => previousData,
|
|
||||||
refetchInterval: queryRefetchIntervalSlow,
|
|
||||||
});
|
|
||||||
|
|
||||||
return { data: data ?? cachedRundownPlaceholder, status, isError, refetch, isFetching };
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,54 +0,0 @@
|
|||||||
import { EntryId, Rundown } from 'ontime-types';
|
|
||||||
import { useMemo } from 'react';
|
|
||||||
|
|
||||||
import { useSelectedEventId } from '../hooks/useSocket';
|
|
||||||
import { getFlatRundownMetadata, type ExtendedEntry } from '../utils/rundownMetadata';
|
|
||||||
import { useProjectRundowns } from './useProjectRundowns';
|
|
||||||
import { useRundownById } from './useRundown';
|
|
||||||
|
|
||||||
export type RundownSource = {
|
|
||||||
rundownId: string | null;
|
|
||||||
rundown: Rundown;
|
|
||||||
flatRundown: ExtendedEntry[];
|
|
||||||
status: string;
|
|
||||||
selectedEventId: EntryId | null;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Explicitly scoped rundown data for views that may operate on a non-loaded rundown.
|
|
||||||
*/
|
|
||||||
export function useScopedRundown(rundownId: string | null): RundownSource {
|
|
||||||
const { data: projectRundowns } = useProjectRundowns();
|
|
||||||
return useRundownSource(rundownId, projectRundowns.loaded || null);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Loaded-rundown source for views that must follow the active runtime rundown.
|
|
||||||
*/
|
|
||||||
export function useLoadedRundownSource(): RundownSource {
|
|
||||||
const { data: projectRundowns } = useProjectRundowns();
|
|
||||||
const loadedRundownId = projectRundowns.loaded || null;
|
|
||||||
return useRundownSource(loadedRundownId, loadedRundownId);
|
|
||||||
}
|
|
||||||
|
|
||||||
function useRundownSource(rundownId: string | null, loadedRundownId: string | null): RundownSource {
|
|
||||||
const isLoadedTarget = rundownId !== null && rundownId === loadedRundownId;
|
|
||||||
const runtimeSelectedEventId = useSelectedEventId();
|
|
||||||
const effectiveSelectedEventId = isLoadedTarget ? runtimeSelectedEventId : null;
|
|
||||||
const { data: rundown, status } = useRundownById(rundownId);
|
|
||||||
const flatRundown = useMemo(
|
|
||||||
() => getFlatRundownMetadata(rundown, effectiveSelectedEventId),
|
|
||||||
[effectiveSelectedEventId, rundown],
|
|
||||||
);
|
|
||||||
|
|
||||||
return useMemo(
|
|
||||||
() => ({
|
|
||||||
rundownId,
|
|
||||||
rundown,
|
|
||||||
flatRundown,
|
|
||||||
status,
|
|
||||||
selectedEventId: effectiveSelectedEventId,
|
|
||||||
}),
|
|
||||||
[effectiveSelectedEventId, flatRundown, rundown, rundownId, status],
|
|
||||||
);
|
|
||||||
}
|
|
||||||
+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,
|
||||||
@@ -34,7 +33,7 @@ import {
|
|||||||
import { useCallback, useMemo } from 'react';
|
import { useCallback, useMemo } from 'react';
|
||||||
|
|
||||||
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 { CURRENT_RUNDOWN_QUERY_KEY, getRundownQueryKey } from '../api/constants';
|
||||||
import {
|
import {
|
||||||
ReorderEntry,
|
ReorderEntry,
|
||||||
deleteEntries,
|
deleteEntries,
|
||||||
@@ -52,6 +51,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<{
|
||||||
@@ -70,16 +70,16 @@ type ClientInsertOptions = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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: string | null) => useEntryActionsForRundown(rundownId ?? '');
|
||||||
|
|
||||||
function useEntryActionsForRundown(scopedRundownId: string | undefined) {
|
function useEntryActionsForRundown(scopedRundownId: string) {
|
||||||
const queryClient = useQueryClient();
|
const queryClient = useQueryClient();
|
||||||
const {
|
const {
|
||||||
linkPrevious,
|
linkPrevious,
|
||||||
@@ -92,13 +92,10 @@ function useEntryActionsForRundown(scopedRundownId: string | undefined) {
|
|||||||
inheritGroupColour,
|
inheritGroupColour,
|
||||||
} = useEditorSettings();
|
} = useEditorSettings();
|
||||||
|
|
||||||
|
// an empty id means the loaded rundown has not resolved yet, the bootstrap alias holds the data
|
||||||
const resolveCurrentRundownQueryKey = useCallback(() => {
|
const resolveCurrentRundownQueryKey = useCallback(() => {
|
||||||
if (scopedRundownId !== undefined) {
|
return scopedRundownId ? getRundownQueryKey(scopedRundownId) : CURRENT_RUNDOWN_QUERY_KEY;
|
||||||
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
|
||||||
|
|||||||
+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,47 @@
|
|||||||
|
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('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());
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -2,13 +2,19 @@ import { create } from 'zustand';
|
|||||||
|
|
||||||
type EntryCopyStore = {
|
type EntryCopyStore = {
|
||||||
entryCopyId: string | null;
|
entryCopyId: string | null;
|
||||||
|
/** rundown the copied entry belongs to, so a paste knows whether it crosses rundowns */
|
||||||
|
entryCopyRundownId: string | null;
|
||||||
entryCopyMode: 'copy' | 'cut';
|
entryCopyMode: 'copy' | 'cut';
|
||||||
setEntryCopyId: (eventId: string | null, mode?: 'copy' | 'cut') => void;
|
setEntryCopyId: (eventId: string | null, rundownId: string | null, 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: string | null, entryCopyRundownId: string | null, mode: 'copy' | 'cut' = 'copy') =>
|
||||||
set({ entryCopyId, entryCopyMode: mode }),
|
set({ entryCopyId, entryCopyRundownId, entryCopyMode: mode }),
|
||||||
}));
|
}));
|
||||||
|
|||||||
@@ -0,0 +1,156 @@
|
|||||||
|
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: 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 = 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();
|
||||||
|
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);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getSelectionMode(event: MouseEvent): SelectionMode {
|
||||||
|
if ((isMacOS() && event.metaKey) || event.ctrlKey) {
|
||||||
|
return 'ctrl';
|
||||||
|
}
|
||||||
|
|
||||||
|
if (event.shiftKey) {
|
||||||
|
return 'shift';
|
||||||
|
}
|
||||||
|
|
||||||
|
return 'click';
|
||||||
|
}
|
||||||
@@ -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';
|
||||||
|
|||||||
@@ -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],
|
||||||
);
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -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';
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user