make custom fields case sensitive (#1242)

* remove custom field lowercasing

* don't allow custom field form to submit duplicate field

* remove unused

* update custom field tests

* also keep upper case when editing

* show key in UI

* also kep upper case when creating a new field

* fix test

* allow old forced case keys to stay as is

* allow space

* add extension to import

* supply initial key to CustomFieldForm

* refactor: improve element contrast

* refactor: style and composition

* consistent use of `customFieldLabelToKey`

* fix CopyTag

* remove log

---------

Co-authored-by: arc-alex <ac@omnivox.dk>
Co-authored-by: Carlos Valente <carlosvalente@pm.me>

apps/client/src/externals.ts

@@ -3,3 +3,4 @@ export const apiRepoLatest = 'https://api.github.com/repos/cpvalente/ontime/rele
 export const websiteUrl = 'https://www.getontime.no';
 
 export const documentationUrl = 'https://docs.getontime.no';
+export const customFieldsDocsUrl = 'https://docs.getontime.no/features/custom-fields/';

apps/client/src/features/app-settings/panel/feature-settings-panel/FeatureSettings.module.scss

@@ -1,3 +1,7 @@
+.halfWidth {
+  width: 50%;
+}
+
 .fullWidth {
   width: 100%;
 }
@@ -37,3 +41,9 @@
 .flex {
   display: flex;
 }
+
+.twoCols {
+  display: grid;
+  grid-template-columns: 1fr 1fr;
+  gap: 1rem;
+}

apps/client/src/features/app-settings/panel/feature-settings-panel/custom-fields/CustomFieldEntry.tsx

@@ -4,6 +4,7 @@ import { IoPencil } from '@react-icons/all-files/io5/IoPencil';
 import { IoTrash } from '@react-icons/all-files/io5/IoTrash';
 import { CustomField, CustomFieldLabel } from 'ontime-types';
 
+import CopyTag from '../../../../../common/components/copy-tag/CopyTag';
 import Swatch from '../../../../../common/components/input/colour-input/Swatch';
 
 import CustomFieldForm from './CustomFieldForm';
@@ -36,6 +37,7 @@ export default function CustomFieldEntry(props: CustomFieldEntryProps) {
             onSubmit={handleEdit}
             initialColour={colour}
             initialLabel={label}
+            initialKey={field}
           />
         </td>
       </tr>
@@ -47,7 +49,12 @@ export default function CustomFieldEntry(props: CustomFieldEntryProps) {
       <td>
         <Swatch color={colour} />
       </td>
-      <td className={style.fullWidth}>{label}</td>
+      <td className={style.halfWidth}>{label}</td>
+      <td className={style.fullWidth}>
+        <CopyTag label='Copy key to use in integrations' copyValue={field}>
+          {field}
+        </CopyTag>
+      </td>
       <td className={style.actions}>
         <IconButton
           size='sm'

apps/client/src/features/app-settings/panel/feature-settings-panel/custom-fields/CustomFieldForm.tsx

@@ -2,10 +2,11 @@ import { useEffect, useState } from 'react';
 import { useForm } from 'react-hook-form';
 import { Button, Input } from '@chakra-ui/react';
 import { CustomField } from 'ontime-types';
-import { isAlphanumeric } from 'ontime-utils';
+import { customFieldLabelToKey, isAlphanumericWithSpace } from 'ontime-utils';
 
 import { maybeAxiosError } from '../../../../../common/api/utils';
 import SwatchSelect from '../../../../../common/components/input/colour-input/SwatchSelect';
+import useCustomFields from '../../../../../common/hooks-query/useCustomFields';
 import * as Panel from '../../PanelUtils';
 
 import style from '../FeatureSettings.module.scss';
@@ -15,10 +16,13 @@ interface CustomFieldsFormProps {
   onCancel: () => void;
   initialColour?: string;
   initialLabel?: string;
+  initialKey?: string;
 }
 
 export default function CustomFieldForm(props: CustomFieldsFormProps) {
-  const { onSubmit, onCancel, initialColour, initialLabel } = props;
+  const { onSubmit, onCancel, initialColour, initialLabel, initialKey } = props;
+  const { data } = useCustomFields();
+
   // we use this to force an update
   const [_, setColour] = useState(initialColour || '');
 
@@ -31,7 +35,7 @@ export default function CustomFieldForm(props: CustomFieldsFormProps) {
     getValues,
     formState: { errors, isSubmitting, isValid, isDirty },
   } = useForm({
-    defaultValues: { label: initialLabel || '', colour: initialColour || '' },
+    defaultValues: { label: initialLabel || '', colour: initialColour || '', key: initialKey || '' },
     resetOptions: {
       keepDirtyValues: true,
     },
@@ -66,28 +70,38 @@ export default function CustomFieldForm(props: CustomFieldsFormProps) {
 
   return (
     <form onSubmit={handleSubmit(setupSubmit)} className={style.fieldForm}>
-      <div className={style.column}>
-        <Panel.Description>Label (only alphanumeric characters are allowed)</Panel.Description>
-        {errors.label && <Panel.Error>{errors.label.message}</Panel.Error>}
-        <Input
-          {...register('label', {
-            required: { value: true, message: 'Required field' },
-            validate: (value) => {
-              if (value.trim().length === 0) return 'Required field';
-              if (!isAlphanumeric(value)) return 'Only alphanumeric characters are allowed';
-              return true;
-            },
-          })}
-          size='sm'
-          variant='ontime-filled'
-          autoComplete='off'
-        />
+      <div className={style.twoCols}>
+        <div>
+          <Panel.Description>Label (only alphanumeric characters are allowed)</Panel.Description>
+          {errors.label && <Panel.Error>{errors.label.message}</Panel.Error>}
+          <Input
+            {...register('label', {
+              required: { value: true, message: 'Required field' },
+              onChange: () => setValue('key', customFieldLabelToKey(getValues('label')) ?? 'N/A'),
+              validate: (value) => {
+                if (value.trim().length === 0) return 'Required field';
+                if (!isAlphanumericWithSpace(value)) return 'Only alphanumeric characters and space are allowed';
+                if (Object.keys(data).includes(value)) return 'Custom fields must be unique';
+                return true;
+              },
+            })}
+            size='sm'
+            variant='ontime-filled'
+            autoComplete='off'
+          />
+        </div>
+
+        <div>
+          <Panel.Description>Key (auto-generated value for use in Integrations and API)</Panel.Description>
+          <Input {...register('key')} disabled size='sm' variant='ontime-filled' autoComplete='off' />
+        </div>
       </div>
 
       <div>
         <Panel.Description>Colour</Panel.Description>
         <SwatchSelect name='colour' value={colour} handleChange={(_field, value) => handleSelectColour(value)} />
       </div>
+
       {errors.root && <Panel.Error>{errors.root.message}</Panel.Error>}
       <div className={style.buttonRow}>
         <Button size='sm' variant='ontime-ghosted' onClick={onCancel}>

apps/client/src/features/app-settings/panel/feature-settings-panel/custom-fields/CustomFields.tsx

@@ -6,13 +6,12 @@ import { CustomField, CustomFieldLabel } from 'ontime-types';
 import { deleteCustomField, editCustomField, postCustomField } from '../../../../../common/api/customFields';
 import ExternalLink from '../../../../../common/components/external-link/ExternalLink';
 import useCustomFields from '../../../../../common/hooks-query/useCustomFields';
+import { customFieldsDocsUrl } from '../../../../../externals';
 import * as Panel from '../../PanelUtils';
 
 import CustomFieldEntry from './CustomFieldEntry';
 import CustomFieldForm from './CustomFieldForm';
 
-const customFieldsDocsUrl = 'https://docs.getontime.no/features/custom-fields/';
-
 export default function CustomFields() {
   const { data, refetch } = useCustomFields();
   const [isAdding, setIsAdding] = useState(false);
@@ -59,9 +58,14 @@ export default function CustomFields() {
           <Alert status='info' variant='ontime-on-dark-info'>
             <AlertIcon />
             <AlertDescription>
-              Custom fields allow for additional information to be added to an event (eg. light, sound, camera). <br />
+              Custom fields allow for additional information to be added to an event.
               <br />
-              This data is not used by Ontime.
+              <br />
+              This data is not used by Ontime, but provides place for cueing or department specific information (eg.
+              light, sound, camera).
+              <br />
+              <br />
+              Custom fields can be used width the Integrations feature using the generated key.
               <ExternalLink href={customFieldsDocsUrl}>See the docs</ExternalLink>
             </AlertDescription>
           </Alert>
@@ -73,6 +77,7 @@ export default function CustomFields() {
               <tr>
                 <th>Colour</th>
                 <th>Name</th>
+                <th>Key (used in Integrations)</th>
                 <th />
               </tr>
             </thead>

apps/client/src/theme/OntimeAlert.ts

@@ -1,7 +1,7 @@
 export const ontimeAlertOnDark = {
   container: {
     fontSize: 'calc(1rem - 1px)',
-    backgroundColor: '#1a1a1a', // $gray-1300
+    backgroundColor: '#202020', // $gray-1200
     color: '#e2e2e2', // $gray-200
     borderRadius: '3px',
   },