feat(url-presets): allow presets to appear as nav menu items (#2110)

apps/server/src/api-data/db/migration/db.migration.v3.ts

@@ -110,14 +110,13 @@ type old_URLPreset = {
 /**
  * migrates a url presets from v3 to v4
  * - pathAndParams split into a target and search
- *
  */
 export function migrateURLPresets(jsonData: object): URLPreset[] | undefined {
   if (is.objectWithKeys(jsonData, ['urlPresets']) && is.array(jsonData.urlPresets)) {
     const oldURLPresets = structuredClone(jsonData.urlPresets) as old_URLPreset;
     const newURLPreset: URLPreset[] = oldURLPresets.map(({ enabled, alias, pathAndParams }) => {
       const [target, search] = pathAndParams.split('?');
-      return { enabled, alias, target, search, options: {} } as URLPreset;
+      return { enabled, alias, target, search, displayInNav: false, options: {} } as URLPreset;
     });
     return newURLPreset;
   }

apps/server/src/api-data/db/migration/migration.test.ts

@@ -208,6 +208,7 @@ describe('v3 to v4', () => {
         target: OntimeView.Timer,
         search:
           'showLeadingZeros=true&timerType=clock&hideClock=true&hideCards=true&hideProgress=true&hideMessage=true&hideSecondary=true&hideLogo=true',
+        displayInNav: false,
         options: {},
       },
       {
@@ -216,6 +217,7 @@ describe('v3 to v4', () => {
         target: OntimeView.Timer,
         search:
           'showLeadingZeros=true&hideClock=true&hideCards=true&hideProgress=true&hideMessage=true&hideSecondary=true&hideLogo=true',
+        displayInNav: false,
         options: {},
       },
     ];

apps/server/src/api-data/url-presets/__tests__/urlPresets.parser.test.ts

@@ -12,7 +12,9 @@ describe('parseUrlPresets()', () => {
 
   it('parses data, skipping invalid results', () => {
     const errorEmitter = vi.fn();
-    const urlPresets = [{ enabled: true, alias: 'alias', target: 'timer', search: 'ss' }] as URLPreset[];
+    const urlPresets = [
+      { enabled: true, alias: 'alias', target: 'timer', search: 'ss', displayInNav: false },
+    ] as URLPreset[];
     const result = parseUrlPresets({ urlPresets }, errorEmitter);
     expect(result.length).toEqual(1);
     expect(result.at(0)).toMatchObject({
@@ -36,6 +38,7 @@ describe('parseUrlPresets()', () => {
           alias: 'testalias',
           target: 'timer',
           search: 'testpathAndParams',
+          displayInNav: false,
         },
       ],
     } as unknown as DatabaseModel;

apps/server/src/api-data/url-presets/urlPresets.parser.ts

@@ -26,6 +26,7 @@ export function parseUrlPresets(data: Partial<DatabaseModel>, emitError?: ErrorE
       alias: preset.alias,
       target: preset.target,
       search: preset.search ?? '',
+      displayInNav: preset.displayInNav ?? false,
       options: preset?.options,
     };
     newPresets.push(newPreset);

apps/server/src/api-data/url-presets/urlPresets.router.ts

@@ -21,6 +21,7 @@ router.post('/', validateNewPreset, async (req: Request, res: Response<URLPreset
       alias: req.body.alias,
       target: req.body.target,
       search: req.body.search,
+      displayInNav: req.body.displayInNav,
       options: req.body.options,
     };
 
@@ -55,6 +56,7 @@ router.put('/:alias', validateUpdatePreset, async (req: Request, res: Response<U
       alias: req.body.alias,
       target: req.body.target,
       search: req.body.search,
+      displayInNav: req.body.displayInNav,
       options: req.body.options ?? existingPreset.options,
     };
 

apps/server/src/api-data/url-presets/urlPresets.validation.ts

@@ -12,6 +12,7 @@ export const validateNewPreset = [
   body('alias').isString().trim().notEmpty(),
   body('target').isString().trim().notEmpty().isIn(Object.values(OntimeView)),
   body('search').isString().trim(),
+  body('displayInNav').isBoolean(),
 
   // options are currently only provided for cuesheet presets
   body('options').optional().isObject(),
@@ -27,6 +28,7 @@ export const validateUpdatePreset = [
   body('alias').isString().trim().notEmpty(),
   body('target').isString().trim().notEmpty().isIn(Object.values(OntimeView)),
   body('search').isString().trim(),
+  body('displayInNav').isBoolean(),
 
   // options are currently only provided for cuesheet presets
   body('options').optional().isObject(),