cpvalente/ontime
1
0
Fork 0
mirror of https://github.com/cpvalente/ontime.git synced 2026-08-14 03:43:50 +00:00
Code Issues Packages Projects Releases 10 Wiki Activity

chore: improve convention entry <> event

Browse Source
This commit is contained in:
Carlos Valente
2025-04-17 12:40:32 +02:00
committed by arc-alex
parent 3754c374c3
commit 3118c20719
28 changed files with 245 additions and 245 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/client/src/features/editors/finder/Finder.tsx
+4 -4
View File
@@ -1,7 +1,7 @@
import { KeyboardEvent, useState } from 'react';
import { Input, Modal, ModalBody, ModalContent, ModalFooter, ModalOverlay } from '@chakra-ui/react';
import { useDebouncedCallback } from '@mantine/hooks';
import { SupportedEvent } from 'ontime-types';
import { SupportedEntry } from 'ontime-types';
import { useEventSelection } from '../../rundown/useEventSelection';
@@ -67,9 +67,9 @@ export default function Finder(props: FinderProps) {
{results.length > 0 &&
results.map((entry, index) => {
const isSelected = selected === index;
const displayIndex = entry.type === SupportedEvent.Event ? entry.eventIndex : '-';
const displayCue = entry.type === SupportedEvent.Event ? entry.cue : '';
const colour = entry.type === SupportedEvent.Event ? entry.colour : '';
const displayIndex = entry.type === SupportedEntry.Event ? entry.eventIndex : '-';
const displayCue = entry.type === SupportedEntry.Event ? entry.cue : '';
const colour = entry.type === SupportedEntry.Event ? entry.colour : '';
return (
<li
apps/client/src/features/editors/finder/useFinder.tsx
+7 -7
View File
@@ -1,19 +1,19 @@
import { ChangeEvent, useEffect, useRef, useState } from 'react';
import { isOntimeBlock, isOntimeEvent, MaybeString, SupportedEvent } from 'ontime-types';
import { isOntimeBlock, isOntimeEvent, MaybeString, SupportedEntry } from 'ontime-types';
import { useFlatRundown } from '../../../common/hooks-query/useRundown';
const maxResults = 12;
type FilterableBlock = {
type: SupportedEvent.Block;
type: SupportedEntry.Block;
id: string;
index: number;
title: string;
};
type FilterableEvent = {
type: SupportedEvent.Event;
type: SupportedEntry.Event;
id: string;
index: number;
eventIndex: number;
@@ -59,7 +59,7 @@ export default function useFinder() {
if (isOntimeEvent(event)) {
if (eventIndex === searchIndex) {
results.push({
type: SupportedEvent.Event,
type: SupportedEntry.Event,
id: event.id,
index: i,
eventIndex,
@@ -93,7 +93,7 @@ export default function useFinder() {
if (event.cue.toLowerCase().includes(searchString)) {
remaining--;
results.push({
type: SupportedEvent.Event,
type: SupportedEntry.Event,
id: event.id,
index: i,
eventIndex,
@@ -126,7 +126,7 @@ export default function useFinder() {
if (event.title.toLowerCase().includes(searchString)) {
remaining--;
results.push({
type: SupportedEvent.Event,
type: SupportedEntry.Event,
id: event.id,
index: i,
eventIndex,
@@ -141,7 +141,7 @@ export default function useFinder() {
if (event.title.toLowerCase().includes(searchString)) {
remaining--;
results.push({
type: SupportedEvent.Block,
type: SupportedEntry.Block,
id: event.id,
index: i,
title: event.title,
apps/client/src/features/operator/Operator.tsx
+2 -2
View File
@@ -1,6 +1,6 @@
import { useCallback, useEffect, useRef, useState } from 'react';
import { useSearchParams } from 'react-router-dom';
import { isOntimeEvent, OntimeEvent, SupportedEvent } from 'ontime-types';
import { isOntimeEvent, OntimeEvent, SupportedEntry } from 'ontime-types';
import { getFirstEventNormal, getLastEventNormal } from 'ontime-utils';
import EmptyPage from '../../common/components/state/EmptyPage';
@@ -197,7 +197,7 @@ export default function Operator() {
);
}
if (entry.type === SupportedEvent.Block) {
if (entry.type === SupportedEntry.Block) {
return <OperatorBlock key={entry.id} title={entry.title} />;
}
return null;
apps/client/src/features/rundown/Rundown.tsx
+11 -11
View File
@@ -10,7 +10,7 @@ import {
isOntimeEvent,
OntimeEntry,
Playback,
SupportedEvent,
SupportedEntry,
} from 'ontime-types';
import {
getFirstNormal,
@@ -84,7 +84,7 @@ export default function Rundown({ data }: RundownProps) {
return;
}
const cloneEntry = entries[copyId];
if (cloneEntry?.type === SupportedEvent.Event) {
if (cloneEntry?.type === SupportedEntry.Event) {
//if we don't have a cursor add the new event on top
const newEvent = cloneEvent(cloneEntry);
addEntry(newEvent, { after: adjustedCursor ?? undefined });
@@ -94,7 +94,7 @@ export default function Rundown({ data }: RundownProps) {
);
const insertAtId = useCallback(
(patch: Partial<OntimeEntry> & { type: SupportedEvent }, id: MaybeString, above = false) => {
(patch: Partial<OntimeEntry> & { type: SupportedEntry }, id: MaybeString, above = false) => {
const options: EventOptions =
id === null
? {}
@@ -202,14 +202,14 @@ export default function Rundown({ data }: RundownProps) {
['mod + Backspace', () => deleteAtCursor(cursor), { preventDefault: true }],
['alt + E', () => insertAtId({ type: SupportedEvent.Event }, cursor), { preventDefault: true }],
['alt + shift + E', () => insertAtId({ type: SupportedEvent.Event }, cursor, true), { preventDefault: true }],
['alt + E', () => insertAtId({ type: SupportedEntry.Event }, cursor), { preventDefault: true }],
['alt + shift + E', () => insertAtId({ type: SupportedEntry.Event }, cursor, true), { preventDefault: true }],
['alt + B', () => insertAtId({ type: SupportedEvent.Block }, cursor), { preventDefault: true }],
['alt + shift + B', () => insertAtId({ type: SupportedEvent.Block }, cursor, true), { preventDefault: true }],
['alt + B', () => insertAtId({ type: SupportedEntry.Block }, cursor), { preventDefault: true }],
['alt + shift + B', () => insertAtId({ type: SupportedEntry.Block }, cursor, true), { preventDefault: true }],
['alt + D', () => insertAtId({ type: SupportedEvent.Delay }, cursor), { preventDefault: true }],
['alt + shift + D', () => insertAtId({ type: SupportedEvent.Delay }, cursor, true), { preventDefault: true }],
['alt + D', () => insertAtId({ type: SupportedEntry.Delay }, cursor), { preventDefault: true }],
['alt + shift + D', () => insertAtId({ type: SupportedEntry.Delay }, cursor, true), { preventDefault: true }],
['mod + C', () => setEntryCopyId(cursor)],
['mod + V', () => insertCopyAtId(cursor, entryCopyId)],
@@ -254,7 +254,7 @@ export default function Rundown({ data }: RundownProps) {
};
if (statefulEntries.length < 1) {
return <RundownEmpty handleAddNew={() => insertAtId({ type: SupportedEvent.Event }, cursor)} />;
return <RundownEmpty handleAddNew={() => insertAtId({ type: SupportedEntry.Event }, cursor)} />;
}
// 1. gather presentation options
@@ -292,7 +292,7 @@ export default function Rundown({ data }: RundownProps) {
<BlockBlock data={entry} hasCursor={hasCursor}>
{entry.events.length === 0 && (
<BlockEmpty
handleAddNew={() => insertAtId({ type: SupportedEvent.Event, parent: entry.id }, entry.id)}
handleAddNew={() => insertAtId({ type: SupportedEntry.Event, parent: entry.id }, entry.id)}
/>
)}
{entry.events.map((eventId, nestedIndex) => {
apps/client/src/features/rundown/RundownEntry.tsx
+8 -8
View File
@@ -6,7 +6,7 @@ import {
OntimeEntry,
OntimeEvent,
Playback,
SupportedEvent,
SupportedEntry,
} from 'ontime-types';
import { useEntryActions } from '../../common/hooks/useEntryAction';
@@ -33,7 +33,7 @@ export type EventItemActions =
| 'clear-report';
interface RundownEntryProps {
type: SupportedEvent;
type: SupportedEntry;
isPast: boolean;
data: OntimeEntry;
loaded: boolean;
@@ -86,7 +86,7 @@ export default function RundownEntry(props: RundownEntryProps) {
const actionHandler = useMemoisedFn((action: EventItemActions, payload?: number | FieldValue) => {
switch (action) {
case 'event': {
const newEvent = { type: SupportedEvent.Event };
const newEvent = { type: SupportedEntry.Event };
const options = {
after: data.id,
lastEventId: previousEventId,
@@ -94,23 +94,23 @@ export default function RundownEntry(props: RundownEntryProps) {
return addEntry(newEvent, options);
}
case 'event-before': {
const newEvent = { type: SupportedEvent.Event };
const newEvent = { type: SupportedEntry.Event };
const options = {
after: previousEntryId,
};
return addEntry(newEvent, options);
}
case 'delay': {
return addEntry({ type: SupportedEvent.Delay }, { after: data.id });
return addEntry({ type: SupportedEntry.Delay }, { after: data.id });
}
case 'delay-before': {
return addEntry({ type: SupportedEvent.Delay }, { after: previousEntryId });
return addEntry({ type: SupportedEntry.Delay }, { after: previousEntryId });
}
case 'block': {
return addEntry({ type: SupportedEvent.Block }, { after: data.id });
return addEntry({ type: SupportedEntry.Block }, { after: data.id });
}
case 'block-before': {
return addEntry({ type: SupportedEvent.Block }, { after: previousEntryId });
return addEntry({ type: SupportedEntry.Block }, { after: previousEntryId });
}
case 'swap': {
const { value } = payload as FieldValue;
apps/client/src/features/rundown/__tests__/rundown.utils.test.ts
+7 -7
View File
@@ -1,4 +1,4 @@
import { OntimeBlock, OntimeEvent, SupportedEvent } from 'ontime-types';
import { OntimeBlock, OntimeEvent, SupportedEntry } from 'ontime-types';
import { makeRundownMetadata } from '../rundown.utils';
@@ -8,7 +8,7 @@ describe('makeRundownMetadata()', () => {
const demoEvents = {
'1': {
id: '1',
type: SupportedEvent.Event,
type: SupportedEntry.Event,
parent: null,
timeStart: 0,
timeEnd: 1,
@@ -20,12 +20,12 @@ describe('makeRundownMetadata()', () => {
} as OntimeEvent,
block: {
id: 'block',
type: SupportedEvent.Block,
type: SupportedEntry.Block,
events: ['11, 12, 13'],
} as OntimeBlock,
'11': {
id: '11',
type: SupportedEvent.Event,
type: SupportedEntry.Event,
parent: 'block',
timeStart: 10,
timeEnd: 11,
@@ -37,7 +37,7 @@ describe('makeRundownMetadata()', () => {
} as OntimeEvent,
'12': {
id: '12',
type: SupportedEvent.Event,
type: SupportedEntry.Event,
parent: 'block',
timeStart: 11,
timeEnd: 12,
@@ -49,7 +49,7 @@ describe('makeRundownMetadata()', () => {
} as OntimeEvent,
'13': {
id: '13',
type: SupportedEvent.Event,
type: SupportedEntry.Event,
parent: 'block',
timeStart: 12,
timeEnd: 13,
@@ -61,7 +61,7 @@ describe('makeRundownMetadata()', () => {
} as OntimeEvent,
'2': {
id: '2',
type: SupportedEvent.Event,
type: SupportedEntry.Event,
parent: null,
timeStart: 20,
timeEnd: 21,
apps/client/src/features/rundown/quick-add-block/QuickAddBlock.tsx
+4 -4
View File
@@ -1,7 +1,7 @@
import { memo, useRef } from 'react';
import { IoAdd } from 'react-icons/io5';
import { Button } from '@chakra-ui/react';
import { MaybeString, SupportedEvent } from 'ontime-types';
import { MaybeString, SupportedEntry } from 'ontime-types';
import { useEntryActions } from '../../../common/hooks/useEntryAction';
@@ -24,7 +24,7 @@ function QuickAddBlock(props: QuickAddBlockProps) {
const addEvent = () => {
addEntry(
{
type: SupportedEvent.Event,
type: SupportedEntry.Event,
parent: parentBlock ?? null,
},
{
@@ -39,7 +39,7 @@ function QuickAddBlock(props: QuickAddBlockProps) {
const addDelay = () => {
addEntry(
// TODO(v4): add delays to blocks
{ type: SupportedEvent.Delay },
{ type: SupportedEntry.Delay },
{
lastEventId: previousEventId,
after: previousEventId,
@@ -52,7 +52,7 @@ function QuickAddBlock(props: QuickAddBlockProps) {
return;
}
addEntry(
{ type: SupportedEvent.Block },
{ type: SupportedEntry.Block },
{
lastEventId: previousEventId,
after: previousEventId,
apps/client/src/features/viewers/ViewWrapper.tsx
+2 -2
View File
@@ -8,7 +8,7 @@ import {
Runtime,
Settings,
SimpleTimerState,
SupportedEvent,
SupportedEntry,
TimerType,
ViewSettings,
} from 'ontime-types';
@@ -63,7 +63,7 @@ const withData = <P extends WithDataProps>(Component: ComponentType<P>) => {
const publicEvents = useMemo(() => {
if (Array.isArray(rundownData)) {
return rundownData.filter((e) => e.type === SupportedEvent.Event && e.title && e.isPublic);
return rundownData.filter((e) => e.type === SupportedEntry.Event && e.title && e.isPublic);
}
return [];
}, [rundownData]);
apps/client/src/features/viewers/countdown/Countdown.tsx
+2 -2
View File
@@ -7,7 +7,7 @@ import {
ProjectData,
Runtime,
Settings,
SupportedEvent,
SupportedEntry,
TimerPhase,
} from 'ontime-types';
@@ -63,7 +63,7 @@ export default function Countdown(props: CountdownProps) {
}
let followThis: OntimeEvent | null = null;
const events: OntimeEvent[] = [...backstageEvents].filter((event) => event.type === SupportedEvent.Event);
const events: OntimeEvent[] = [...backstageEvents].filter((event) => event.type === SupportedEntry.Event);
if (eventId !== null) {
followThis = events.find((event) => event.id === eventId) || null;
apps/client/src/features/viewers/countdown/CountdownSelect.tsx
+2 -2
View File
@@ -1,5 +1,5 @@
import { Link } from 'react-router-dom';
import { OntimeEntry, OntimeEvent, SupportedEvent } from 'ontime-types';
import { OntimeEntry, OntimeEvent, SupportedEntry } from 'ontime-types';
import Empty from '../../../common/components/state/Empty';
import { formatTime } from '../../../common/utils/time';
@@ -19,7 +19,7 @@ export default function CountdownSelect(props: CountdownSelectProps) {
const { events } = props;
const { getLocalizedString } = useTranslation();
const filteredEvents = events.filter((event: OntimeEntry) => event.type === SupportedEvent.Event) as OntimeEvent[];
const filteredEvents = events.filter((event: OntimeEntry) => event.type === SupportedEntry.Event) as OntimeEvent[];
return (
<div className='event-select' data-testid='countdown__select'>