feat: ontime actions in automation

apps/client/src/features/app-settings/panel/automations-panel/AutomationForm.module.scss

@@ -27,7 +27,8 @@
 .titleSection,
 .filterSection,
 .oscSection,
-.httpSection {
+.httpSection,
+.actionSection {
   display: grid;
   grid-gap: 0.5rem;
 
@@ -40,8 +41,10 @@
 .ruleSection,
 .filterSection,
 .oscSection,
-.httpSection {
-  label, div {
+.httpSection,
+.actionSection {
+  label,
+  div {
     // we use the div as non-interactive placeholder for button cells
     // it needs to match the size of the label element
     font-size: calc(1rem - 3px);
@@ -51,7 +54,6 @@
   }
 }
 
-
 .titleSection {
   grid-template-columns: 1fr;
 }
@@ -68,6 +70,14 @@
   grid-template-columns: 1fr auto;
 }
 
+.actionSection {
+  grid-template-columns: auto 1fr 1fr auto;
+
+  .test {
+    grid-column: -1;
+  }
+}
+
 .outputCard {
   border-left: 0.25rem solid $gray-1200;
   padding-left: 0.5rem;

apps/client/src/features/app-settings/panel/automations-panel/AutomationForm.tsx

@@ -3,7 +3,16 @@ import { Controller, useFieldArray, useForm } from 'react-hook-form';
 import { Button, IconButton, Input, Radio, RadioGroup, Select } from '@chakra-ui/react';
 import { IoAdd } from '@react-icons/all-files/io5/IoAdd';
 import { IoTrash } from '@react-icons/all-files/io5/IoTrash';
-import { Automation, AutomationDTO, HTTPOutput, isHTTPOutput, isOSCOutput, OSCOutput } from 'ontime-types';
+import {
+  Automation,
+  AutomationDTO,
+  HTTPOutput,
+  isHTTPOutput,
+  isOntimeAction,
+  isOSCOutput,
+  OntimeAction,
+  OSCOutput,
+} from 'ontime-types';
 
 import { addAutomation, editAutomation, testOutput } from '../../../../common/api/automation';
 import { maybeAxiosError } from '../../../../common/api/utils';
@@ -18,6 +27,7 @@ import * as Panel from '../../panel-utils/PanelUtils';
 
 import TemplateInput from './template-input/TemplateInput';
 import { isAutomation, makeFieldList } from './automationUtils';
+import OntimeActionForm from './OntimeActionForm';
 
 import style from './AutomationForm.module.scss';
 
@@ -42,6 +52,7 @@ export default function AutomationForm(props: AutomationFormProps) {
     register,
     setError,
     setFocus,
+    setValue,
     formState: { errors, isSubmitting, isDirty, isValid },
   } = useForm<AutomationDTO>({
     mode: 'onChange',
@@ -92,6 +103,11 @@ export default function AutomationForm(props: AutomationFormProps) {
     appendOutput({ type: 'http', url: '' });
   };
 
+  const handleAddnewOntimeAction = () => {
+    // @ts-expect-error -- we dont want to choose an action
+    appendOutput({ type: 'ontime', action: undefined });
+  };
+
   const handleTestOSCOutput = async (index: number) => {
     try {
       const values = getValues(`outputs.${index}`) as OSCOutput;
@@ -125,6 +141,19 @@ export default function AutomationForm(props: AutomationFormProps) {
     }
   };
 
+  const handleTestOntimeAction = async (index: number) => {
+    try {
+      const values = getValues(`outputs.${index}`) as OntimeAction;
+      // NOTE: there is no meaningful validation to do here, we let the server deal with the data
+      await testOutput({
+        ...values,
+        type: 'ontime',
+      });
+    } catch (_error) {
+      /** we dont handle errors here */
+    }
+  };
+
   const onSubmit = async (values: AutomationDTO) => {
     if (isAutomation(automation)) {
       await handleEdit(automation.id, { id: automation.id, ...values });
@@ -374,8 +403,6 @@ export default function AutomationForm(props: AutomationFormProps) {
                         size='sm'
                         onClick={() => removeOutput(index)}
                         color='#FA5656' // $red-500
-                        isDisabled={false}
-                        isLoading={false}
                       />
                     </Panel.InlineElements>
                   </div>
@@ -423,8 +450,6 @@ export default function AutomationForm(props: AutomationFormProps) {
                         size='sm'
                         onClick={() => removeOutput(index)}
                         color='#FA5656' // $red-500
-                        isDisabled={false}
-                        isLoading={false}
                       />
                     </Panel.InlineElements>
                   </div>
@@ -432,30 +457,59 @@ export default function AutomationForm(props: AutomationFormProps) {
               </div>
             );
           }
+
+          if (isOntimeAction(output)) {
+            const rowErrors = errors.outputs?.[index] as
+              | {
+                  action?: { message?: string };
+                  time?: { message?: string };
+                  text?: { message?: string };
+                  visible?: { message?: string };
+                  secondarySource?: { message?: string };
+                }
+              | undefined;
+            return (
+              <div key={output.id} className={style.outputCard}>
+                <Tag>Ontime action</Tag>
+                <OntimeActionForm
+                  value={output.action}
+                  index={index}
+                  register={register}
+                  rowErrors={rowErrors}
+                  setValue={setValue}
+                >
+                  <span>&nbsp;</span>
+                  <Panel.InlineElements relation='inner'>
+                    <Button size='sm' variant='ontime-ghosted-white' onClick={() => handleTestOntimeAction(index)}>
+                      Test
+                    </Button>
+                    <IconButton
+                      aria-label='Delete'
+                      icon={<IoTrash />}
+                      variant='ontime-ghosted'
+                      size='sm'
+                      onClick={() => removeOutput(index)}
+                      color='#FA5656' // $red-500
+                    />
+                  </Panel.InlineElements>
+                </OntimeActionForm>
+              </div>
+            );
+          }
+
           // there should be no other output types
           return null;
         })}
         <Panel.InlineElements relation='inner'>
-          <Button
-            variant='ontime-subtle'
-            rightIcon={<IoAdd />}
-            size='sm'
-            onClick={handleAddNewOSCOutput}
-            isDisabled={false}
-            isLoading={false}
-          >
+          <Button variant='ontime-subtle' rightIcon={<IoAdd />} size='sm' onClick={handleAddNewOSCOutput}>
             OSC
           </Button>
-          <Button
-            variant='ontime-subtle'
-            rightIcon={<IoAdd />}
-            size='sm'
-            onClick={handleAddNewHTTPOutput}
-            isDisabled={false}
-            isLoading={false}
-          >
+          <Button variant='ontime-subtle' rightIcon={<IoAdd />} size='sm' onClick={handleAddNewHTTPOutput}>
             HTTP
           </Button>
+          <Button variant='ontime-subtle' rightIcon={<IoAdd />} size='sm' onClick={handleAddnewOntimeAction}>
+            Ontime action
+          </Button>
         </Panel.InlineElements>
       </div>
 

apps/client/src/features/app-settings/panel/automations-panel/OntimeActionForm.tsx

@@ -0,0 +1,110 @@
+import { PropsWithChildren, useState } from 'react';
+import { UseFormRegister, UseFormSetValue } from 'react-hook-form';
+import { Input, Select } from '@chakra-ui/react';
+import { AutomationDTO, OntimeAction } from 'ontime-types';
+
+import { cx } from '../../../../common/utils/styleUtils';
+import * as Panel from '../../panel-utils/PanelUtils';
+
+import style from './AutomationForm.module.scss';
+
+interface OntimeActionFormProps {
+  index: number;
+  register: UseFormRegister<AutomationDTO>;
+  rowErrors?: {
+    action?: { message?: string };
+    time?: { message?: string };
+    text?: { message?: string };
+    visible?: { message?: string };
+    secondarySource?: { message?: string };
+  };
+  value: OntimeAction['action'];
+  setValue: UseFormSetValue<AutomationDTO>;
+}
+
+export default function OntimeActionForm(props: PropsWithChildren<OntimeActionFormProps>) {
+  const { index, register, setValue, rowErrors, value, children } = props;
+  const [selectedAction, setSelectedAction] = useState<OntimeAction['action']>(value || 'aux-start');
+
+  const updateSelectedAction = (value: string) => {
+    setSelectedAction(value as OntimeAction['action']);
+    setValue(`outputs.${index}.action`, value as OntimeAction['action']);
+  };
+
+  return (
+    <div className={cx([style.actionSection, selectedAction && style[selectedAction]])}>
+      <input type='hidden' {...register(`outputs.${index}.action`)} value={selectedAction} />
+      <label>
+        Action
+        <Select
+          variant='ontime'
+          size='sm'
+          value={selectedAction}
+          onChange={(event) => updateSelectedAction(event.target.value)}
+        >
+          <option value='aux-start'>Auxiliary timer: start</option>
+          <option value='aux-pause'>Auxiliary timer: pause</option>
+          <option value='aux-stop'>Auxiliary timer: stop</option>
+          <option value='aux-set'>Auxiliary timer: set</option>
+          <option value='message-set'>Timer: timer message</option>
+          <option value='message-secondary'>Timer: timer secondary</option>
+        </Select>
+        <Panel.Error>{rowErrors?.action?.message}</Panel.Error>
+      </label>
+
+      {selectedAction === 'aux-set' && (
+        <label>
+          New time
+          <Input
+            {...register(`outputs.${index}.time`, {
+              required: { value: true, message: 'Required field' },
+            })}
+            variant='ontime-filled'
+            size='sm'
+            placeholder='eg: 10m5s'
+            autoComplete='off'
+          />
+          <Panel.Error>{rowErrors?.time?.message}</Panel.Error>
+        </label>
+      )}
+
+      {selectedAction === 'message-set' && (
+        <>
+          <label>
+            Text (leave empty for no change)
+            <Input
+              {...register(`outputs.${index}.text`)}
+              variant='ontime-filled'
+              size='sm'
+              placeholder='eg: Timer is finished'
+              autoComplete='off'
+            />
+            <Panel.Error>{rowErrors?.text?.message}</Panel.Error>
+          </label>
+          <label>
+            Visibility
+            <Select variant='ontime' size='sm' {...register(`outputs.${index}.visible`)}>
+              <option value=''>Untouched</option>
+              <option value='true'>Show</option>
+              <option value='false'>Hide</option>
+            </Select>
+            <Panel.Error>{rowErrors?.visible?.message}</Panel.Error>
+          </label>
+        </>
+      )}
+
+      {selectedAction === 'message-secondary' && (
+        <label>
+          Timer secondary source
+          <Select variant='ontime' size='sm' {...register(`outputs.${index}.secondarySource`)}>
+            <option value='aux'>Auxiliary timer</option>
+            <option value='external'>External</option>
+            <option value='null'>None</option>
+          </Select>
+          <Panel.Error>{rowErrors?.secondarySource?.message}</Panel.Error>
+        </label>
+      )}
+      <div className={style.test}>{children}</div>
+    </div>
+  );
+}