refactor: freeze is view option

apps/client/src/common/api/viewSettings.ts

@@ -2,14 +2,23 @@ import axios from 'axios';
 import type { ViewSettings } from 'ontime-types';
 
 import { apiEntryUrl } from './constants';
-const viewSettingsPath = apiEntryUrl + '/view-settings';
 
-export async function getViewSettings() {
+const viewSettingsPath = `${apiEntryUrl}/view-settings`;
+
+/**
+ * HTTP request to fetch view settings
+ * @returns
+ */
+export async function getViewSettings(): Promise<ViewSettings> {
   const res = await axios.get(viewSettingsPath);
   return res.data;
 }
 
-export async function postViewSettings(data: ViewSettings) {
+/**
+ * HTTP request to update view settings
+ * needs to update entire objects, not just a patch
+ */
+export async function postViewSettings(data: ViewSettings): Promise<ViewSettings> {
   const res = await axios.post(viewSettingsPath, data);
-  return res.data as ViewSettings;
+  return res.data;
 }

apps/client/src/common/components/view-params-editor/ViewParamsEditor.tsx

@@ -39,8 +39,6 @@ function ViewParamsEditor({ viewOptions }: EditFormDrawerProps) {
 
     const newParamsObject = Object.fromEntries(new FormData(formEvent.currentTarget));
     const newSearchParams = getURLSearchParamsFromObj(newParamsObject, viewOptions);
-
-    console.log('New search params:', newParamsObject, newSearchParams.toString());
     setSearchParams(newSearchParams);
   };
 

apps/client/src/common/models/ViewSettings.type.ts

@@ -2,8 +2,6 @@ import { ViewSettings } from 'ontime-types';
 
 export const viewsSettingsPlaceholder: ViewSettings = {
   dangerColor: '#ED3333',
-  endMessage: '',
-  freezeEnd: false,
   normalColor: '#ffffffcc',
   overrideStyles: false,
   warningColor: '#FFAB33',

apps/client/src/features/app-settings/panel/settings-panel/ViewSettings.tsx

@@ -7,7 +7,6 @@ import { maybeAxiosError } from '../../../../common/api/utils';
 import Button from '../../../../common/components/buttons/Button';
 import Info from '../../../../common/components/info/Info';
 import { SwatchPickerRHF } from '../../../../common/components/input/colour-input/SwatchPicker';
-import Input from '../../../../common/components/input/input/Input';
 import ExternalLink from '../../../../common/components/link/external-link/ExternalLink';
 import Switch from '../../../../common/components/switch/Switch';
 import useViewSettings from '../../../../common/hooks-query/useViewSettings';
@@ -26,7 +25,6 @@ export default function ViewSettings() {
     control,
     handleSubmit,
     setError,
-    register,
     reset,
     setValue,
     watch,
@@ -122,31 +120,6 @@ export default function ViewSettings() {
               <SwatchPickerRHF name='dangerColor' control={control} />
             </Panel.ListItem>
           </Panel.ListGroup>
-          <Panel.ListGroup>
-            <Panel.ListItem>
-              <Panel.Field
-                title='Freeze timer on end'
-                description='When a timer hits 00:00:00, it freezes instead of going negative. It invalidates the End Message.'
-              />
-              <Switch
-                size='large'
-                checked={watch('freezeEnd')}
-                onCheckedChange={(value: boolean) => setValue('freezeEnd', value, { shouldDirty: true })}
-              />
-            </Panel.ListItem>
-            <Panel.ListItem>
-              <Panel.Field
-                title='End message'
-                description='Message for negative timers; applies only if the timer isn`t frozen on End. If no message is provided, it continues into negative time'
-              />
-              <Input
-                maxLength={150}
-                style={{ width: '275px' }}
-                placeholder='Shown when timer reaches end'
-                {...register('endMessage')}
-              />
-            </Panel.ListItem>
-          </Panel.ListGroup>
         </Panel.Section>
       </Panel.Card>
     </Panel.Section>

apps/client/src/features/app-settings/quick-start/QuickStart.tsx

@@ -126,28 +126,6 @@ export default function QuickStart({ isOpen, onClose }: QuickStartProps) {
               />
             </Panel.ListItem>
           </Panel.ListGroup>
-
-          <Panel.ListGroup>
-            <Panel.ListItem>
-              <Panel.Field
-                title='Freeze timer on end'
-                description='When a timer hits 00:00:00, it freezes instead of going negative. It invalidates the End Message.'
-              />
-              <Switch
-                size='large'
-                name='viewSettings.freezeEnd'
-                checked={watch('viewSettings.freezeEnd')}
-                onCheckedChange={(checked) => setValue('viewSettings.freezeEnd', checked)}
-              />
-            </Panel.ListItem>
-            <Panel.ListItem>
-              <Panel.Field
-                title='End message'
-                description='Message for negative timers; applies only if the timer isn`t frozen on End. If no message is provided, it continues into negative time'
-              />
-              <Input maxLength={150} fluid placeholder='eg: Time is up!' {...register('viewSettings.endMessage')} />
-            </Panel.ListItem>
-          </Panel.ListGroup>
         </form>
       }
       footerElements={

apps/client/src/features/app-settings/quick-start/quickStart.utils.ts

@@ -8,8 +8,4 @@ export const quickStartDefaults: QuickStartData = {
     timeFormat: '24',
     language: 'en',
   },
-  viewSettings: {
-    freezeEnd: false,
-    endMessage: '',
-  },
 };

apps/client/src/features/control/message/TimerPreview.tsx

@@ -25,7 +25,7 @@ export default function TimerPreview() {
     if (showTimerMessage) return 'Message';
     if (timerType === TimerType.None) return timerPlaceholder;
     if (phase === TimerPhase.Pending) return 'Standby to start';
-    if (phase === TimerPhase.Overtime && data.endMessage) return 'Custom end message';
+    if (phase === TimerPhase.Overtime) return 'Timer Overtime';
     if (timerType === TimerType.Clock) return 'Clock';
     if (countToEnd) return 'Count to End';
     return 'Timer';

apps/server/src/api-data/db/db.validation.ts

@@ -30,10 +30,6 @@ export const validateQuickProject = [
   body('settings.timeFormat').optional().isIn(['12', '24']),
   body('settings.language').optional().isString().trim(),
 
-  // ViewSettings fields
-  body('viewSettings.freezeEnd').optional().isBoolean(),
-  body('viewSettings.endMessage').optional().isString().trim(),
-
   requestValidationFunction,
 ];
 

apps/server/src/api-data/view-settings/viewSettings.parser.ts

@@ -16,8 +16,6 @@ export function parseViewSettings(data: Partial<DatabaseModel>, emitError?: Erro
 
   return {
     dangerColor: data.viewSettings.dangerColor ?? dbModel.viewSettings.dangerColor,
-    endMessage: data.viewSettings.endMessage ?? dbModel.viewSettings.endMessage,
-    freezeEnd: data.viewSettings.freezeEnd ?? dbModel.viewSettings.freezeEnd,
     normalColor: data.viewSettings.normalColor ?? dbModel.viewSettings.normalColor,
     overrideStyles: data.viewSettings.overrideStyles ?? dbModel.viewSettings.overrideStyles,
     warningColor: data.viewSettings.warningColor ?? dbModel.viewSettings.warningColor,

apps/server/src/api-data/view-settings/viewSettings.router.ts

@@ -18,17 +18,17 @@ router.post('/', validateViewSettings, async (req: Request, res: Response<ViewSe
   try {
     const newData = {
       dangerColor: req.body.dangerColor,
-      endMessage: req.body.endMessage,
-      freezeEnd: req.body.freezeEnd,
       normalColor: req.body.normalColor,
       overrideStyles: req.body.overrideStyles,
       warningColor: req.body.warningColor,
     } as ViewSettings;
     await getDataProvider().setViewSettings(newData);
-    res.status(200).send(newData);
+
     setImmediate(() => {
       sendRefetch(RefetchKey.ViewSettings);
     });
+
+    res.status(200).send(newData);
   } catch (error) {
     const message = getErrorMessage(error);
     res.status(400).send({ message });

apps/server/src/api-data/view-settings/viewSettings.validation.ts

@@ -6,8 +6,6 @@ import { requestValidationFunction } from '../validation-utils/validationFunctio
  */
 export const validateViewSettings = [
   body('dangerColor').isString().trim().withMessage('dangerColor value must be string'),
-  body('endMessage').isString().trim().withMessage('endMessage value must be string'),
-  body('freezeEnd').isBoolean().withMessage('freezeEnd value must be boolean'),
   body('normalColor').isString().trim().withMessage('normalColor value must be string'),
   body('overrideStyles').isBoolean().withMessage('overrideStyles value must be boolean'),
   body('warningColor').isString().trim().withMessage('warningColor value must be string'),

apps/server/src/models/dataModel.ts

@@ -35,8 +35,6 @@ export const dbModel: DatabaseModel = {
     normalColor: '#ffffffcc',
     warningColor: '#FFAB33',
     dangerColor: '#ED3333',
-    freezeEnd: false,
-    endMessage: '',
   },
   urlPresets: [],
   customFields: {},

apps/server/src/models/demoProject.ts

@@ -519,8 +519,6 @@ export const demoDb: DatabaseModel = {
   },
   viewSettings: {
     dangerColor: '#ED3333',
-    endMessage: '',
-    freezeEnd: false,
     normalColor: '#ffffffcc',
     overrideStyles: false,
     warningColor: '#FFAB33',

apps/server/test-db/db.json

@@ -468,8 +468,6 @@
   },
   "viewSettings": {
     "dangerColor": "#ED3333",
-    "endMessage": "",
-    "freezeEnd": false,
     "normalColor": "#ffffffcc",
     "overrideStyles": false,
     "warningColor": "#FFAB33"

e2e/tests/fixtures/e2e-test-db.json

@@ -485,8 +485,6 @@
   },
   "viewSettings": {
     "dangerColor": "#ED3333",
-    "endMessage": "",
-    "freezeEnd": false,
     "normalColor": "#ffffffcc",
     "overrideStyles": false,
     "warningColor": "#FFAB33"

packages/types/src/api/db/db.type.ts

@@ -3,5 +3,4 @@ import { type DatabaseModel } from '../../definitions/DataModel.type.js';
 export interface QuickStartData {
   project: Pick<DatabaseModel['project'], 'title'>;
   settings: Pick<DatabaseModel['settings'], 'timeFormat' | 'language'>;
-  viewSettings: Pick<DatabaseModel['viewSettings'], 'freezeEnd' | 'endMessage'>;
 }

packages/types/src/definitions/core/Views.type.ts

@@ -1,7 +1,5 @@
 export type ViewSettings = {
   dangerColor: string;
-  endMessage: string;
-  freezeEnd: boolean;
   normalColor: string;
   overrideStyles: boolean;
   warningColor: string;