From 754cc2ef988c62d1edc4dbc2effb2fd939a1990f Mon Sep 17 00:00:00 2001 From: Ari Date: Sat, 6 Aug 2022 22:37:26 -0400 Subject: [PATCH] added more support for trigger types --- .../OptionManager/TriggerCalendar.tsx | 39 ++++++ .../NodeEditor/OptionManager/TriggerSun.tsx | 39 ++++++ .../OptionManager/TriggerWebhook.tsx | 6 +- .../OptionManager/getOptionManager.ts | 6 + .../components/NodeEditor/index.stories.tsx | 131 ++++++++---------- webapp/src/components/NodeEditor/utils.ts | 14 ++ webapp/src/types/automations/triggers.ts | 10 +- webapp/src/types/validators/triggers.ts | 15 ++ webapp/src/utils/automations.ts | 3 + 9 files changed, 190 insertions(+), 73 deletions(-) create mode 100644 webapp/src/components/NodeEditor/OptionManager/TriggerCalendar.tsx create mode 100644 webapp/src/components/NodeEditor/OptionManager/TriggerSun.tsx diff --git a/webapp/src/components/NodeEditor/OptionManager/TriggerCalendar.tsx b/webapp/src/components/NodeEditor/OptionManager/TriggerCalendar.tsx new file mode 100644 index 0000000..04d1f81 --- /dev/null +++ b/webapp/src/components/NodeEditor/OptionManager/TriggerCalendar.tsx @@ -0,0 +1,39 @@ +import { OptionManager } from "./OptionManager"; +import { AutomationTriggerCalendar } from "types/automations/triggers"; +import { InputList } from "components/Inputs/InputList"; +import InputText from "components/Inputs/Base/InputText"; + +export const TriggerCalendarState: OptionManager = { + defaultState: (): AutomationTriggerCalendar => ({ + platform: "calendar", + event: "sunset", + }), + isReady: () => true, + Component: ({ state, setState }) => { + return ( + <> + + setState({ + ...state, + event, + }) + } + /> + + setState({ + ...state, + offset: !s ? undefined : s, + }) + } + /> + + ); + }, +}; diff --git a/webapp/src/components/NodeEditor/OptionManager/TriggerSun.tsx b/webapp/src/components/NodeEditor/OptionManager/TriggerSun.tsx new file mode 100644 index 0000000..0d45664 --- /dev/null +++ b/webapp/src/components/NodeEditor/OptionManager/TriggerSun.tsx @@ -0,0 +1,39 @@ +import { OptionManager } from "./OptionManager"; +import { AutomationTriggerSun } from "types/automations/triggers"; +import { InputList } from "components/Inputs/InputList"; +import InputText from "components/Inputs/Base/InputText"; + +export const TriggerSunState: OptionManager = { + defaultState: (): AutomationTriggerSun => ({ + platform: "sun", + event: "sunset", + }), + isReady: () => true, + Component: ({ state, setState }) => { + return ( + <> + + setState({ + ...state, + event, + }) + } + /> + + setState({ + ...state, + offset: !s ? undefined : s, + }) + } + /> + + ); + }, +}; diff --git a/webapp/src/components/NodeEditor/OptionManager/TriggerWebhook.tsx b/webapp/src/components/NodeEditor/OptionManager/TriggerWebhook.tsx index f88a749..17de014 100644 --- a/webapp/src/components/NodeEditor/OptionManager/TriggerWebhook.tsx +++ b/webapp/src/components/NodeEditor/OptionManager/TriggerWebhook.tsx @@ -8,7 +8,7 @@ export const TriggerWebhook: OptionManager = { webhook_id: "", }), isReady: () => true, - renderOptionList: (state, setState) => { + Component: ({ state, setState }) => { return ( <> = { }) } /> + + You can run this automation by sending an HTTP POST request to + http://your-home-assistant-ip/api/webhook/{state.webhook_id}. + ); }, diff --git a/webapp/src/components/NodeEditor/OptionManager/getOptionManager.ts b/webapp/src/components/NodeEditor/OptionManager/getOptionManager.ts index c2d273d..b67abd4 100644 --- a/webapp/src/components/NodeEditor/OptionManager/getOptionManager.ts +++ b/webapp/src/components/NodeEditor/OptionManager/getOptionManager.ts @@ -20,6 +20,8 @@ import { TriggerZone } from "./TriggerZone"; import { TriggerDevice } from "./TriggerDevice"; import { ActionStopState } from "./ActionStop"; import { ActionParallelState } from "./ActionParallel"; +import { TriggerSunState } from "./TriggerSun"; +import { TriggerCalendarState } from "./TriggerCalendar"; export const getOptionManager = ( nodeType: T, @@ -58,6 +60,10 @@ export const getOptionManager = ( return TriggerHAState; case "mqtt": return TriggerMQTTState; + case "sun": + return TriggerSunState; + case "calendar": + return TriggerCalendarState; case "numeric_state": return TriggerNumericState; case "state": diff --git a/webapp/src/components/NodeEditor/index.stories.tsx b/webapp/src/components/NodeEditor/index.stories.tsx index b4c2a50..869d212 100644 --- a/webapp/src/components/NodeEditor/index.stories.tsx +++ b/webapp/src/components/NodeEditor/index.stories.tsx @@ -1,57 +1,55 @@ import React from "react"; -import { ComponentMeta, ComponentStory } from "@storybook/react"; -import { NodeEditor } from "."; +import { ComponentStory } from "@storybook/react"; +import { NodeEditor, NodeEditorProps } from "."; import { AutomationCondition } from "types/automations/conditions"; import { Button } from "components/Inputs/Buttons/Button"; import { useState } from "react"; import { Modal } from "components/Modal"; import { Page } from "components/Page"; +import { makeStory } from "devUtils"; -export default { - title: "NodeEditor", - component: NodeEditor, - parameters: { actions: { argTypesRegex: "^on.*" } }, - args: { - node: { - data: {}, - service: "", - target: "", +const { componentMeta, make } = makeStory({ + meta: { + title: "NodeEditor", + args: { + node: { + data: {}, + service: "", + target: "", + }, }, }, -} as ComponentMeta; + Component: (props: NodeEditorProps) => { + const [state, setState] = useState(props.node); + return ( + + { + setState(s); + props.onSave && props.onSave(s); + }} + /> + + ); + }, +}); -const Base: ComponentStory = (props) => { - const [state, setState] = useState(props.node); - return ( - - { - setState(s); - props.onSave && props.onSave(s); - }} - /> - - ); -}; -export const Action = Base.bind({}); -export const SingleOption = Action.bind({}); -SingleOption.args = { - ...SingleOption.args, +export default componentMeta; + +export const Action = make({}); +export const SingleOption = make({ allowedTypes: ["action"], -}; -export const Condition = Action.bind({}); -Condition.args = { - ...Condition.args, +}); +export const Condition = make({ node: { condition: "and", conditions: [ { condition: "numeric_state", entity_id: ["sensor.kitchen_humidity"], - conditions: [], above: "40", }, { @@ -59,26 +57,22 @@ Condition.args = { value_template: "states('switch.kitchen') == 'on'", }, ], - } as AutomationCondition, -}; + }, +}); -export const UnSupported = Action.bind({}); -UnSupported.args = { - ...UnSupported.args, +export const UnSupported = make({ node: { condition: "bargs", platform: "rouge", } as any, -}; +}); -export const DeviceTriggerExample = Action.bind({}); -DeviceTriggerExample.args = { - ...DeviceTriggerExample.args, +export const DeviceTriggerExample = make({ node: { platform: "device", device_id: "bd83b10cb1c7aa028c12dade5b4e87d5", }, -}; +}); export const InAModal: ComponentStory = (props) => { const [open, setOpen] = useState(false); @@ -92,19 +86,15 @@ export const InAModal: ComponentStory = (props) => { ); }; -export const ServiceExample = Action.bind({}); -ServiceExample.args = { - ...ServiceExample.args, +export const ServiceExample = make({ node: { target: {}, data: {}, service: "", }, -}; +}); -export const ServiceWithDataExample = Action.bind({}); -ServiceWithDataExample.args = { - ...ServiceWithDataExample.args, +export const ServiceWithDataExample = make({ node: { target: { entity: "light.switch_baby", @@ -114,37 +104,29 @@ ServiceWithDataExample.args = { }, service: "light.turn_on", }, -}; +}); -export const DelayExample = Action.bind({}); -DelayExample.args = { - ...DelayExample.args, +export const DelayExample = make({ node: { wait_template: "", }, -}; +}); -export const StateTriggerExample = Action.bind({}); -StateTriggerExample.args = { - ...StateTriggerExample.args, +export const StateTriggerExample = make({ node: { platform: "state", entity_id: "binary_sensor.door_main", }, -}; +}); -export const DeviceActionFilledExample = Action.bind({}); -DeviceActionFilledExample.args = { - ...DeviceActionFilledExample.args, +export const DeviceActionFilledExample = make({ node: { type: "toggle", device_id: "c9711be86b0301955f72380509285485", - }, -}; + } as any, +}); -export const NotifyPhoneViaDeviceAction = Action.bind({}); -NotifyPhoneViaDeviceAction.args = { - ...NotifyPhoneViaDeviceAction.args, +export const NotifyPhoneViaDeviceAction = make({ node: { device_id: "2a98db84af7526c7ec3cc7aebd1a9e1c", domain: "mobile_app", @@ -152,4 +134,11 @@ NotifyPhoneViaDeviceAction.args = { title: "Hassio Status", message: "Hassio Is turning off...", } as any, -}; +}); + +export const Sun = make({ + node: { + platform: "sun", + event: "sunset", + }, +}); diff --git a/webapp/src/components/NodeEditor/utils.ts b/webapp/src/components/NodeEditor/utils.ts index f057c25..4589a7c 100644 --- a/webapp/src/components/NodeEditor/utils.ts +++ b/webapp/src/components/NodeEditor/utils.ts @@ -8,6 +8,20 @@ const subtypeDescMap: Partial> = { repeat: "repeat a sequence until or while some conditions are met", device: "device related actions", service: "call a service", + event: "Fires when an event is being received.", + homeassistant: "Fires when Home Assistant starts up or shuts down.", + mqtt: "Fires when a specific message is received on given MQTT topic.", + sun: "Fires when the sun is setting or rising.", + numeric_state: + "Fires when the numeric value of an entity's state or attribute changes.", + state: "Fires when an entity's state or attribute changes", + template: "Evaluate a custom template", + time: "Specify a certain time to run", + webhook: + "Webhook trigger fires when a web request is made to the webhook endpoint", + zone: "Specify when an entity enters or leaves a zone", + tag: "Fires when a tag is scanned.", + calendar: "Fires when a Calendar event starts or ends.", }; export const getNodeSubTypeDescription = ( diff --git a/webapp/src/types/automations/triggers.ts b/webapp/src/types/automations/triggers.ts index 467ee8a..63656ef 100644 --- a/webapp/src/types/automations/triggers.ts +++ b/webapp/src/types/automations/triggers.ts @@ -26,6 +26,10 @@ export type AutomationTriggerZone = st.Infer; export type AutomationTriggerDevice = st.Infer< typeof v.AutomationTriggerDevice >; +export type AutomationTriggerSun = st.Infer; +export type AutomationTriggerCalendar = st.Infer< + typeof v.AutomationTriggerCalendar +>; export type ActionTriggerMapping = { homeassistant: AutomationTriggerHA; @@ -39,6 +43,8 @@ export type ActionTriggerMapping = { time: AutomationTriggerTime; webhook: AutomationTriggerWebhook; zone: AutomationTriggerZone; + sun: AutomationTriggerSun; + calendar: AutomationTriggerCalendar; }; export type TriggerType = keyof ActionTriggerMapping; @@ -54,4 +60,6 @@ export type AutomationTrigger = | AutomationTriggerTime | AutomationTriggerWebhook | AutomationTriggerZone - | AutomationTriggerDevice; + | AutomationTriggerDevice + | AutomationTriggerSun + | AutomationTriggerCalendar; diff --git a/webapp/src/types/validators/triggers.ts b/webapp/src/types/validators/triggers.ts index d6af473..0a04d1c 100644 --- a/webapp/src/types/validators/triggers.ts +++ b/webapp/src/types/validators/triggers.ts @@ -96,6 +96,20 @@ export const AutomationTriggerZone = st.type({ event: st.enums(["enter", "leave"]), }); +export const AutomationTriggerSun = st.type({ + ...AutomationTriggerBase, + platform: st.literal("sun"), + event: st.enums(["sunset", "sunrise"]), + offset: st.optional(st.string()), +}); + +export const AutomationTriggerCalendar = st.type({ + ...AutomationTriggerBase, + platform: st.literal("calendar"), + event: st.enums(["start", "end"]), + offset: st.optional(st.string()), +}); + export const AutomationTriggerDevice = st.type({ ...AutomationTriggerBase, ..._AutomationDeviceState, @@ -103,6 +117,7 @@ export const AutomationTriggerDevice = st.type({ }); export const AutomationTrigger = st.union([ + AutomationTriggerSun, AutomationTriggerEvent, AutomationTriggerHA, AutomationTriggerMQTT, diff --git a/webapp/src/utils/automations.ts b/webapp/src/utils/automations.ts index 94fe1bf..4e30341 100644 --- a/webapp/src/utils/automations.ts +++ b/webapp/src/utils/automations.ts @@ -73,6 +73,8 @@ export const getSubTypeList = (nodeType: T) => { "zone", "event", "homeassistant", + "sun", + "calendar", "mqtt", "tag", "template", @@ -161,6 +163,7 @@ export const TriggerValidators: Record = { time: v.triggers.AutomationTriggerTime, webhook: v.triggers.AutomationTriggerWebhook, zone: v.triggers.AutomationTriggerZone, + sun: v.triggers.AutomationTriggerSun, }; export const ActionValidators: Record = {