Compare commits

...
28 Commits
Author SHA1 Message Date
ari 621f43e5c8 v0.1.10 2022-05-18 11:57:34 -04:00
ari f3496f9d32 fixed nodejs test 2022-05-18 11:04:15 -04:00
ari 409cf2b21a simpler names 2022-05-18 11:03:07 -04:00
ari ef92261666 reverting something stupid 2022-05-18 11:01:29 -04:00
ari 83edaf9bf8 tagged names 2022-05-18 11:00:41 -04:00
ari f8efd895a9 not building 2022-05-18 10:59:35 -04:00
ari da0d153b81 fixed up linting 2022-05-18 10:58:26 -04:00
ari bcd262dd46 - fixed up optional metadata + + desc
- using timestamp for default new ids
'
2022-05-18 10:54:53 -04:00
ari ea47b3e1eb fixed up automation time 2022-05-18 10:37:41 -04:00
ari 5192c09681 trying to provide test 2022-05-18 09:50:08 -04:00
ari d3adfaaacb making sure the version is required 2022-05-17 22:16:09 -04:00
ari c249a94b3d fixing up typo 2022-05-17 22:15:44 -04:00
ari dce028d0bc clean up 2022-05-17 22:15:18 -04:00
ari 7333f9e159 added manual build 2022-05-17 22:15:06 -04:00
ari 809095f8e0 added edge tag 2022-05-17 22:14:38 -04:00
ari 8942693a32 added a manual build 2022-05-17 22:13:57 -04:00
ari db49ed02ed updated tsc 2022-05-17 22:10:08 -04:00
ari cce2e03053 fixed up trigger issues 2022-05-17 22:03:22 -04:00
ari 4509a224a9 minor style patch 2022-05-17 21:51:20 -04:00
ari 7f8b75fa02 added installation instructions 2022-05-17 21:46:47 -04:00
ari d2c5310b93 new version release 2022-05-17 21:31:10 -04:00
ari a19db93c37 support for malformed automations 2022-05-17 20:48:43 -04:00
ari 6c57408f27 making PRs don't trigger deployments 2022-05-17 12:20:28 -04:00
ari b9a77746c0 updated changelog 2022-05-17 12:19:34 -04:00
ari f1ffab13be fixed up unittest 2022-05-17 12:18:15 -04:00
Ari Sosnovsky 52fcfd9271 Merge pull request #9 from issy/main 2022-05-17 07:50:30 -04:00
Issy Szemeti f435bb70aa Spelling 2022-05-17 11:05:41 +01:00
root 2598c23fd2 no local host 2022-05-16 23:56:47 -04:00
52 changed files with 1419 additions and 236 deletions

No files matched your search

+34
View File
@@ -0,0 +1,34 @@
name: "Manual Build"
on:
workflow_dispatch:
inputs:
version:
type: string
description: "Version Number"
required: true
jobs:
build:
runs-on: ubuntu-latest
name: "${{ github.event.inputs.version }} / ${{ matrix.arch }}"
strategy:
matrix:
arch: ["aarch64", "amd64", "armhf", "armv7", "i386"]
steps:
- name: Check out repository
uses: actions/checkout@v3
- name: Login to DockerHub
uses: docker/login-action@v2.0.0
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Build & Push to Dockerhub
uses: home-assistant/builder@2022.03.1
with:
args: |
--${{ matrix.arch }} \
--version ${{ github.event.inputs.version }} \
--additional-tag edge \
--target .
+29 -32
View File
@@ -1,19 +1,17 @@
name: Deploy
env:
MONITORED_FILES: "apparmor.txt build.yaml config.yaml Dockerfile data rootfs"
on:
# release:
# types: [published]
on:
workflow_dispatch:
push:
branch: [main]
paths:
- 'config.yaml'
- "config.yaml"
jobs:
metadata:
runs-on: ubuntu-latest
name: Metadata
outputs:
outputs:
version: ${{ steps.version.outputs.VERSION }}
changlelog: ${{ steps.changlelog.outputs.CHANGELOG }}
steps:
@@ -30,42 +28,41 @@ jobs:
run: |
echo ::set-output name=CHANGELOG::$(cat CHANGELOG.md)
build:
runs-on: ubuntu-latest
name: Build & Publish ${{ matrix.arch }}
needs:
- metadata
strategy:
matrix:
arch: ["aarch64", "amd64", "armhf", "armv7", "i386"]
# build:
# runs-on: ubuntu-latest
# name: Build & Publish ${{ matrix.arch }}
# needs:
# - metadata
# strategy:
# matrix:
# arch: ["aarch64", "amd64", "armhf", "armv7", "i386"]
steps:
- name: Check out repository
uses: actions/checkout@v3
- name: Login to DockerHub
uses: docker/login-action@v2.0.0
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
# steps:
# - name: Check out repository
# uses: actions/checkout@v3
- name: Build & Push to Dockerhub - ${{ matrix.arch }} / ${{ needs.metadata.outputs.version }}
uses: home-assistant/builder@2022.03.1
with:
args: |
--${{ matrix.arch }} \
--target .
# - name: Login to DockerHub
# uses: docker/login-action@v2.0.0
# with:
# username: ${{ secrets.DOCKERHUB_USERNAME }}
# password: ${{ secrets.DOCKERHUB_TOKEN }}
# - name: Build & Push to Dockerhub - ${{ matrix.arch }} / ${{ needs.metadata.outputs.version }}
# uses: home-assistant/builder@2022.03.1
# with:
# args: |
# --${{ matrix.arch }} \
# --target .
publish:
runs-on: ubuntu-latest
needs:
- metadata
- build
name: Publish Github Release
steps:
- name: Publish Release ${{ needs.metadata.outputs.version }}
uses: actions/github-script@v6
env:
env:
VERSION: ${{ needs.metadata.outputs.version }}
CHANGELOG: ${{ needs.metadata.outputs.changlelog }}
with:
@@ -75,4 +72,4 @@ jobs:
repo: context.repo.repo,
tag_name: process.env.VERSION,
body: process.env.CHANGELOG,
});
});
+7 -1
View File
@@ -61,6 +61,12 @@ jobs:
nodejs:
name: "NodeJs Tests"
runs-on: ubuntu-latest
strategy:
matrix:
action:
- "test:ci"
- "tsc:ci"
- "build"
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
@@ -71,7 +77,7 @@ jobs:
- name: Install Dependencies
run: cd webapp && yarn install
- name: Run Tests
run: cd webapp && yarn test:ci
run: cd webapp && yarn ${{ matrix.action }}
+56 -1
View File
@@ -1,5 +1,60 @@
# Changelog -- v0.1.6
# Changelog
## [0.1.10] - More Bug Fixes
- Allowing null or undefined values for metadata fields
- Trigger.platform==time will now have the .at property better supported
## [0.1.9] - Fixed up invalid types for various triggers
- Some triggers had invalid types and were causing a false-positive validation
## [0.1.8] - Support for Malformed Automations
- API will no longer error out on missing values or invalid lists
- Frontend has support for displaying bad automations
## [0.1.6] - Mobile Mode
- Improved mobile mode
- Fixed up arrow styles due to typos
- Added selection color
## [0.1.2] - Docker Hub Images
- Publishing images to docker hub is now stable
## [0.0.15] - Publish to dockerhub
- Publishing images to docker hub
## [0.0.14] - Using vanila ha yaml
- Supporing vanilla out of the box HA yaml as oppose to parsing them (no more $smType)
- Conditions have now a more a explicit node
## [0.0.13] - Better Styling with react-flow
- Fixed up styling (using react-flow)
- cleaned up some button styles
## [0.0.12] - Tags
- Added tag management system for automations
## [0.0.11] - Zoom
- Added lazy saving
## [0.0.10] - Zoom
- Introducing Zoom!
## [0.0.9] - First Working Version
- Instalable verion via github
- Initial POC done
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+18 -2
View File
@@ -7,7 +7,7 @@ A better way to write automations in home-assistant without having to install an
![image](https://user-images.githubusercontent.com/7451445/168672840-71ceaa8a-2bee-443e-9150-5b0f03b05d08.png)
A [home-assistent addon](https://www.home-assistant.io/addons/) for a better UI for managing your automations & scripts. We provide a way to visualize and develop your automation using a visual-programming language that draws inspirations from [Node-Red](https://nodered.org/).
A [home-assistant addon](https://www.home-assistant.io/addons/) for a better UI for managing your automations & scripts. We provide a way to visualize and develop your automation using a visual-programming language that draws inspirations from [Node-Red](https://nodered.org/).
## Features
@@ -23,12 +23,28 @@ A [home-assistent addon](https://www.home-assistant.io/addons/) for a better UI
See roadmap in [Version 1 Github Project](https://github.com/asosnovsky/Shortumation/projects/1).
## Installation
### Addon
Add the repository URL under **Supervisor → Add-on store → ⋮ → Manage add-on repositories**:
https://github.com/asosnovsky/Shortumation
It should now appear in your `Add-on Store` and you should be able to install it!
### Containerized
Please note that this way of using Shortumation is **not future proof**, currently we use the `/config/automation.yaml` file as our source of truth for the automations. Which means that we do not need access to the HA API or Websockets. In future release you may need to configure some additional compomenents to enable this.
If this warning does not scare you or you still want to try things out, then take a look at the example [docker-compose.yaml](example/containerized/docker-compose.yaml).
## FAQ
**How is this different from Node-Red?**
> Node-Red is both an execution engine and an automation editor, which means that in order for you automations to run you have to have an additional component running and executing the automations. Shortumations simply provides a different editor and manager for writing Homeassistant automations, while relying on Homeassistant to execute the automations (this uses the `automations.yaml` file as the backend database)
> Node-Red is both an execution engine and an automation editor, which means that in order for you automations to run you have to have an additional component running and executing the automations. Shortumation simply provides a different editor and manager for writing Homeassistant automations, while relying on Homeassistant to execute the automations (this uses the `automations.yaml` file as the backend database)
**Which HA Installation does this support?**
+13 -4
View File
@@ -1,4 +1,4 @@
from typing import Iterator, Union
from typing import Any, Iterator, Union
from pydantic.error_wrappers import ValidationError
@@ -26,18 +26,27 @@ def load_automation(
try:
yield ExtenededAutomationData(
metadata=AutomationMetdata.parse_obj(auto_raw),
condition=load_conditions(auto_raw.get("condition", [])),
sequence=load_conditions(auto_raw.get("action", [])),
trigger=normalize_obj(auto_raw.get("trigger", [])),
condition=ifempty_or_null_then_list(load_conditions(auto_raw.get("condition", []))),
sequence=ifempty_or_null_then_list(load_conditions(auto_raw.get("action", []))),
trigger=ifempty_or_null_then_list(normalize_obj(auto_raw.get("trigger", []))),
tags=tags,
)
except ValidationError as err:
raise InvalidAutomationFile from err
def ifempty_or_null_then_list(obj: Any):
if not isinstance(obj, list):
return []
else:
return obj
def load_conditions(conditions: Union[dict, list, str]):
if isinstance(conditions, list):
return list(map(ensure_condition_dictionary, conditions))
elif not conditions:
return []
else:
return [ensure_condition_dictionary(conditions)]
+2 -2
View File
@@ -1,4 +1,4 @@
from typing import Dict, List, Literal, Optional, Union
from typing import Dict, List, Optional, Union
from pydantic import BaseModel
from pydantic.fields import Field
@@ -9,7 +9,7 @@ class AutomationMetdata(BaseModel):
alias: Optional[str] = None
description: Optional[str] = None
trigger_variables: Optional[Dict[str, Union[str, int, bool, float]]] = None
mode: Literal["single", "restart", "queued", "parallel"] = "single"
mode: str = "single"
class AutomationData(BaseModel):
+28
View File
@@ -811,3 +811,31 @@
device_id: das2qdasdasdasadaasd
default: []
mode: single
- id: 'baddy-1'
alias: 'bad triggers'
description: ''
trigger: ""
condition: []
action: []
mode: single
- id: 'baddy-2'
alias: 'null things'
description: ''
trigger:
condition:
action:
mode: single
- id: 'baddy-3'
alias: 'big null things'
description:
trigger:
condition:
action:
mode: single
- id: 'bad mode'
alias: 'bade mode'
description: ""
trigger: []
condition: []
action: []
mode: bad
+12 -12
View File
@@ -24,7 +24,7 @@ class BaseTestCase(TestCase):
class automation_list_tests(BaseTestCase):
test_params = {"total": 28, "subtest2_found_items": 3, "subtest1_found_items": 10}
test_params = {"total": 32, "subtest2_found_items": 7, "subtest1_found_items": 10}
def test_get_list_of_everything(self):
data = self.client.post(
@@ -106,25 +106,25 @@ class automation2_lists_tests(automation_list_tests):
class automation_update_tests(BaseTestCase):
def test_insert_new(self):
resp = self.client.post("/automations/list", json={"limit": 1, "offset": 0})
self.assertEqual(resp.json()["totalItems"], 28)
self.assertEqual(resp.json()["totalItems"], 32)
resp = self.client.post(
"/automations",
"/automations/item",
json={
"index": 29,
"index": 33,
"data": AutomationData(metadata=AutomationMetdata(id="testme")).dict(),
},
)
self.assertEqual(resp.status_code, 200)
resp = self.client.post("/automations/list", json={"limit": 1, "offset": 28})
resp = self.client.post("/automations/list", json={"limit": 1, "offset": 32})
data = resp.json()
self.assertEqual(data["totalItems"], 29)
self.assertEqual(data["totalItems"], 33)
self.assertEqual(data["data"][0]["metadata"]["id"], "testme")
def test_update_some(self):
resp = self.client.post("/automations/list", json={"limit": 1, "offset": 20})
original_auto = resp.json()["data"][0]
resp = self.client.post(
"/automations",
"/automations/item",
json={
"index": 20,
"data": AutomationData(metadata=AutomationMetdata(id="testme")).dict(),
@@ -143,7 +143,7 @@ class automation_update_tests(BaseTestCase):
original_auto = resp.json()["data"][0]
original_auto["metadata"]["alias"] = "I CHANGED!"
resp = self.client.post(
"/automations",
"/automations/item",
json={
"index": 15,
"data": original_auto,
@@ -194,7 +194,7 @@ class automation_update_tests(BaseTestCase):
original_auto = resp.json()["data"][0]
original_auto["metadata"]["alias"] = "I CHANGED!"
resp = self.client.post(
"/automations",
"/automations/item",
json={
"index": 27,
"data": original_auto,
@@ -324,13 +324,13 @@ class automation_update_tests(BaseTestCase):
class automation_delete_tests(BaseTestCase):
def test_delete_some(self):
resp = self.client.post("/automations/list", json={"limit": 1, "offset": 0})
self.assertEqual(resp.json()["totalItems"], 28)
self.assertEqual(resp.json()["totalItems"], 32)
resp = self.client.delete(
"/automations",
"/automations/item",
json={
"index": 20,
},
)
self.assertEqual(resp.status_code, 200)
resp = self.client.post("/automations/list", json={"limit": 1, "offset": 0})
self.assertEqual(resp.json()["totalItems"], 27)
self.assertEqual(resp.json()["totalItems"], 31)
@@ -24,11 +24,11 @@ class manager_tests(TestCase):
_, _, loader = get_example_automation_loader()
self.assertIsNone(loader.get(-1))
self.assertIsNone(loader.get(1_000))
self.assertIsNone(loader.get(31))
self.assertIsNone(loader.get(33))
def test_length(self):
_, _, loader = get_example_automation_loader()
self.assertEqual(loader.get_total_items(), 28)
self.assertEqual(loader.get_total_items(), 32)
def test_bad_automations_file(self):
folder, _, manager = get_dummy_automation_loader(
@@ -51,11 +51,11 @@ class manager_tests(TestCase):
def test_create_automation_with_example_folder(self):
_, _, manager = get_example_automation_loader()
self.assertEqual(manager.get_total_items(), 28)
manager.update(32, ExtenededAutomationData(metadata=AutomationMetdata(id="test1")))
auto = manager.get(28)
self.assertEqual(manager.get_total_items(), 32)
manager.update(40, ExtenededAutomationData(metadata=AutomationMetdata(id="test1")))
auto = manager.get(32)
self.assertIsNotNone(auto)
self.assertEqual(manager.get_total_items(), 29)
self.assertEqual(manager.get_total_items(), 33)
self.assertEqual(auto.metadata.id, "test1") # type: ignore
def test_update_automation(self):
+2 -2
View File
@@ -1,5 +1,5 @@
name: Shortumation
version: 0.1.6
version: 0.1.10
slug: shortumation
image: asosnovsky/shortumation-{arch}
url: "https://github.com/asosnovsky/Shortumation"
@@ -20,7 +20,7 @@ panel_icon: mdi:home-automation
hassio_role: manager
privileged:
- SYS_RAWIO
host_network: true
host_network: false
auth_api: true
map:
- config:rw
+21
View File
@@ -0,0 +1,21 @@
version: '3'
services:
homeassistant:
container_name: homeassistant
image: "ghcr.io/home-assistant/home-assistant:stable"
volumes:
- config:/config
restart: unless-stopped
privileged: true
network_mode: host
shortumation:
# make sure to replace the ARCH with whatever system you are running!
image: "asosnovsky/shortumation-${ARCH:-amd64}:latest"
volumes:
- config:/config
ports:
- 8081:8000
volumes:
config:
+3
View File
@@ -15,6 +15,7 @@
"react-jss": "^10.8.2",
"react-router-dom": "6",
"react-scripts": "4.0.3",
"superstruct": "^0.15.4",
"theming": "^3.3.0",
"typescript": "^4.1.2",
"web-vitals": "^1.0.1",
@@ -23,6 +24,8 @@
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"tsc": "tsc -w",
"tsc:ci": "tsc",
"test:ci": "react-scripts test --ci=true --all --watchAll=false",
"test": "react-scripts test",
"test:debug": "react-scripts --inspect-brk test --runInBand --no-cache",
@@ -80,8 +80,8 @@ export const AutoInfoBox: FC<Props> = ({
return <div className={`automation-editor--info-box ${className}`}>
<div className="automation-editor--info-box-inner">
<InputText label="ID" value={metadata.id} onChange={onUpdateMetadata('id')} />
<InputText label="Name" value={metadata.alias} onChange={onUpdateMetadata('alias')} />
<InputTextArea label="Description" value={metadata.description} onChange={onUpdateMetadata('description')} />
<InputText label="Name" value={metadata.alias ?? ""} onChange={onUpdateMetadata('alias')} />
<InputTextArea label="Description" value={metadata.description ?? ""} onChange={onUpdateMetadata('description')} />
<InputList
label="Mode"
current={metadata.mode}
@@ -5,6 +5,14 @@
height: 100%;
}
.automation-editor-failures {
display: flex;
flex-direction: column;
padding: 1em;
overflow: scroll;
height: 100%;
}
.automation-editor--flow-wrapper {
flex: 1;
padding: 0 0.5em 0 0.5em;
@@ -111,3 +111,63 @@ EmptyStart.args = {
sequence: []
}
}
export const BadAutomationInvalidMetadata = Template.bind({})
BadAutomationInvalidMetadata.args = {
...BadAutomationInvalidMetadata.args,
automation: {
condition: [],
tags: {},
metadata: {
} as any,
trigger: [
],
sequence: []
}
}
export const BadAutomationInvalidTriggers = Template.bind({})
BadAutomationInvalidTriggers.args = {
...BadAutomationInvalidTriggers.args,
automation: {
condition: [],
tags: {},
metadata: {
id: "random",
alias: "Random",
description: "Example Metadata",
trigger_variables: {
'wowo': '!'
},
mode: 'single',
},
trigger: [
"haha I am a string"
] as any,
sequence: []
}
}
export const BadAutomationInvalidSequence = Template.bind({})
BadAutomationInvalidSequence.args = {
...BadAutomationInvalidSequence.args,
automation: {
condition: [],
tags: {},
metadata: {
id: "random",
alias: "Bad Choose Sequence",
description: "Example Metadata",
trigger_variables: {
'wowo': '!'
},
mode: 'single',
},
trigger: [],
sequence: [
{
choose: {}
}
] as any
}
}
@@ -5,9 +5,11 @@ import { AutomationData } from "types/automations";
import { AutoInfoBox } from "./AutoInfoBox";
import { ButtonIcon } from "components/Icons/ButtonIcons";
import { Button } from "components/Inputs/Button";
import { useAutomatioEditorState } from "./state";
import { DAGAutomationFlow } from "components/DAGFlow";
import { useAutomatioEditorState, EditorData } from './state';
import { SafeDAGAutomationFlow } from "components/DAGFlow/safe";
import { DAGAutomationFlowDims } from "components/DAGFlow/types";
import { MiniFailure } from 'types/validators/helper';
import InputYaml from "components/Inputs/InputYaml";
interface Props {
automation?: AutomationData;
@@ -26,7 +28,9 @@ export const AutomationEditor: FC<Props> = ({
updateTrigger,
updateMetadata,
updateCondition,
validate,
save,
saveAndUpdate,
} = useAutomatioEditorState(propsAutos, propsOnUpdate);
const [closeInfo, setCloseInfo] = useState(false);
@@ -37,6 +41,14 @@ export const AutomationEditor: FC<Props> = ({
Loading...
</div>
}
if (state.status === 'invalid') {
return <ValidationBox
failures={state.failures}
data={state.data}
validate={validate}
onSave={saveAndUpdate}
/>
}
return <div className="automation-editor">
<AutoInfoBox
className={closeInfo ? "hide" : "show"}
@@ -61,7 +73,7 @@ export const AutomationEditor: FC<Props> = ({
Save <CheckMarkIcon color="#bf4" />
</Button>
</div>
<DAGAutomationFlow
<SafeDAGAutomationFlow
className="automation-editor--flow-wrapper--flow"
sequence={state.data.sequence}
trigger={state.data.trigger}
@@ -74,3 +86,58 @@ export const AutomationEditor: FC<Props> = ({
</div>
</div>
}
export const ValidationBox: FC<{
failures: MiniFailure[]
validate: (d: any) => MiniFailure[] | null,
data: EditorData,
onSave: (d: EditorData) => void,
}> = props => {
const [{ failures, data }, setState] = useState({
failures: props.failures,
data: props.data,
});
const makeSave = <K extends keyof EditorData>(k: K) => (d: EditorData[K]) => {
const newData = {
...data,
[k]: d,
}
const newFails = props.validate(newData);
if (newFails) {
setState({
failures: newFails,
data: newData,
})
} else {
setState({
failures: [],
data: newData,
})
}
}
return <div className="automation-editor-failures">
<ul>
{failures.map((f, i) => <>
<li key={i}>
<b>{f.path}</b>:
<ul>
{f.message.map((m, j) => <li key={j}>
{m}
</li>)}
</ul>
</li>
</>)}
</ul>
<span>Please correct the automation file manually and then continue!</span>
<InputYaml label="Metadata" value={data.metadata} onChange={makeSave('metadata')} resizable />
<InputYaml label="Tags" value={data.tags} onChange={makeSave('tags')} resizable />
<InputYaml label="Trigger" value={data.trigger} onChange={makeSave('trigger')} resizable />
<InputYaml label="Condition" value={data.condition} onChange={makeSave('condition')} resizable />
<InputYaml label="Actions" value={data.sequence} onChange={makeSave('sequence')} resizable />
<Button disabled={failures.length > 0} onClick={() => props.onSave(data)}>Save</Button>
</div>
}
+39 -18
View File
@@ -1,6 +1,8 @@
import { useState, useEffect } from 'react';
import { AutomationData, AutomationMetadata } from "types/automations";
import * as v from "types/validators/autmation";
import { getFailures } from "types/validators/helper";
import { MiniFailure } from '../../types/validators/helper';
export type EditorData = ReturnType<typeof genEditorData>;
export type EditorState = {
@@ -8,6 +10,10 @@ export type EditorState = {
data: EditorData
} | {
status: 'loading'
} | {
status: 'invalid',
failures: MiniFailure[],
data: EditorData,
}
export type EditorStatus = EditorState['status'];
@@ -20,7 +26,7 @@ export const useAutomatioEditorState = (
});
const makeUpdate = <K extends keyof EditorData, D extends EditorData[K]>(name: K) => (
data: D
) => state.status !== 'loading' && update({
) => ((state.status === 'changed') || (state.status === 'unchanged')) && update({
status: 'changed',
data: {
...state.data,
@@ -28,21 +34,46 @@ export const useAutomatioEditorState = (
}
})
const saveAndUpdate = (data: EditorData) => {
const cleanData = {
...data,
tags: data.tags.reduce((all, [tagName, tagValue]) => ({
...all,
[tagName.trim()]: tagValue.trim(),
}), {})
};
update({
status: "loading",
})
onSave(cleanData);
}
useEffect(() => {
if (automation) {
update({
status: 'unchanged',
data: genEditorData(automation),
})
const failures = getFailures(automation, v.AutomationData);
if (failures) {
update({
status: 'invalid',
failures,
data: genEditorData(automation),
})
} else {
update({
status: 'unchanged',
data: genEditorData(automation),
})
}
}
}, [automation]);
return {
validate: (data: any) => getFailures(data, v.AutomationData),
updateTrigger: makeUpdate('trigger'),
updateSequence: makeUpdate('sequence'),
updateCondition: makeUpdate('condition'),
saveAndUpdate,
updateMetadata: (metadata: AutomationMetadata, tags: Array<[string, string]>) => {
if (state.status !== 'loading') {
if ((state.status === 'changed') || (state.status === 'unchanged')) {
update({
status: 'changed',
data: {
@@ -55,17 +86,7 @@ export const useAutomatioEditorState = (
},
save: () => {
if (state.status !== 'loading') {
const data = {
...state.data,
tags: state.data.tags.reduce((all, [tagName, tagValue]) => ({
...all,
[tagName]: tagValue,
}), {})
};
update({
status: "loading",
})
onSave(data);
saveAndUpdate(state.data)
}
},
get state() {
@@ -62,5 +62,498 @@ FewAutos.args = {
createMockAuto({ "Room": "Office", "Type": "Lights" }),
createMockAuto({ "Room": "Office" }),
createMockAuto(),
{
"metadata": {
"id": "1649947692702",
"alias": "Bed Remote",
"description": "",
"trigger_variables": null,
"mode": "single"
},
"trigger": [
{
"device_id": "asdasdasdas",
"domain": "zha",
"platform": "device",
"type": "remote_button_short_press",
"subtype": "turn_on",
"id": "turn_on"
},
{
"device_id": "asdasdasdas",
"domain": "zha",
"platform": "device",
"type": "remote_button_short_press",
"subtype": "turn_off",
"id": "turn_off"
},
{
"device_id": "asdasdasdas",
"domain": "zha",
"platform": "device",
"type": "remote_button_short_press",
"subtype": "dim_up",
"id": "dim_up"
},
{
"device_id": "asdasdasdas",
"domain": "zha",
"platform": "device",
"type": "remote_button_short_press",
"subtype": "dim_down",
"id": "dim_down"
},
{
"device_id": "asdasdasdas",
"domain": "zha",
"platform": "device",
"type": "remote_button_double_press",
"subtype": "turn_on",
"id": "up_dbclk"
}
],
"condition": [],
"sequence": [
{
"choose": [
{
"conditions": [
{
"condition": "trigger",
"id": "turn_off"
}
],
"sequence": [
{
"type": "turn_off",
"device_id": "asdasdasdasdas",
"entity_id": "light.bulb_ari_lamp",
"domain": "light"
}
]
},
{
"conditions": [
{
"condition": "trigger",
"id": "turn_on"
}
],
"sequence": [
{
"service": "light.turn_on",
"data": {
"color_temp": 153,
"brightness_pct": 100
},
"target": {
"device_id": "asdasdasdasdas"
}
}
]
},
{
"conditions": [
{
"condition": "trigger",
"id": "dim_up"
}
],
"sequence": [
{
"device_id": "asdasdasdasdas",
"domain": "light",
"entity_id": "light.bulb_ari_lamp",
"type": "brightness_increase"
}
]
},
{
"conditions": [
{
"condition": "trigger",
"id": "dim_down"
}
],
"sequence": [
{
"device_id": "asdasdasdasdas",
"domain": "light",
"entity_id": "light.bulb_ari_lamp",
"type": "brightness_decrease"
}
]
},
{
"conditions": [
{
"condition": "trigger",
"id": "up_dbclk"
}
],
"sequence": [
{
"service": "light.turn_on",
"data": {
"color_temp": 500,
"brightness_pct": 100
},
"target": {
"device_id": "asdasdasdasdas"
}
}
]
}
],
"default": []
}
],
"tags": {
"Type": "Remote",
"Room": "Bedroom"
}
},
{
"metadata": {
"id": "1641617168123",
"alias": "Ensure On",
"description": "",
"trigger_variables": null,
"mode": "single"
},
"trigger": [
{
"platform": "device",
"type": "turned_off",
"device_id": "tasdasdasdasdasdasda",
"entity_id": "switch.power_washer",
"domain": "switch"
},
{
"platform": "device",
"type": "turned_off",
"device_id": "dasdasdasdasdas",
"entity_id": "switch.plug_living_room_tv",
"domain": "switch"
}
],
"condition": [],
"sequence": [
{
"type": "turn_on",
"device_id": "tasdasdasdasdasdasda",
"entity_id": "switch.power_washer",
"domain": "switch"
},
{
"type": "turn_on",
"device_id": "dasdasdasdasdas",
"entity_id": "switch.plug_living_room_tv",
"domain": "switch"
}
],
"tags": {}
},
{
"metadata": {
"id": "1649726828269",
"alias": "Climate Heat Mode Settings",
"description": "Ensures that the climate is always in sync with the house settings",
"trigger_variables": null,
"mode": "single"
},
"trigger": [
{
"platform": "state",
"entity_id": "climate.main_floor",
"id": "main"
},
{
"platform": "state",
"entity_id": "climate.second_floor",
"id": "second"
},
{
"platform": "state",
"entity_id": "input_boolean.thermostats_house_is_heating",
"id": "setting"
}
],
"condition": [],
"sequence": [
{
"choose": [
{
"conditions": [
{
"condition": "trigger",
"id": "setting"
}
],
"sequence": [
{
"service": "climate.turn_off",
"data": {},
"target": {
"device_id": [
"d88dcfe82bc9a1c0f2b77b871848155e",
"ef2d47fdeef19f8984b85f92f2597f73"
]
}
}
]
},
{
"conditions": [
{
"condition": "state",
"entity_id": "input_boolean.thermostats_house_is_heating",
"state": "on"
}
],
"sequence": [
{
"choose": [
{
"conditions": [
{
"condition": "and",
"conditions": [
{
"condition": "template",
"value_template": "{{ trigger.to_state.state != 'heat' }}"
},
{
"condition": "template",
"value_template": "{{ trigger.to_state.state != 'off' }}"
}
]
}
],
"sequence": [
{
"service": "climate.set_hvac_mode",
"data": {
"hvac_mode": "heat"
},
"target": {
"entity_id": "{{ trigger.entity_id }}"
}
}
]
}
]
}
]
}
],
"default": [
{
"choose": [
{
"conditions": [
{
"condition": "and",
"conditions": [
{
"condition": "template",
"value_template": "{{ trigger.to_state.state != 'cool' }}"
},
{
"condition": "template",
"value_template": "{{ trigger.to_state.state != 'off' }}"
}
]
}
],
"sequence": [
{
"service": "climate.set_hvac_mode",
"data": {
"hvac_mode": "cool"
},
"target": {
"entity_id": "{{ trigger.entity_id }}"
}
}
]
}
]
}
]
}
],
"tags": {}
},
{
"metadata": {
"id": "1628024070687",
"alias": "Baby Light Setting",
"description": "Configures max/min light settings for the baby ",
"trigger_variables": null,
"mode": "single"
},
"trigger": [
{
"platform": "time",
"at": "21:00:00",
"id": "night"
},
{
"platform": "time",
"at": "07:30:00",
"id": "day"
}
],
"condition": [],
"sequence": [
{
"choose": [
{
"conditions": [
{
"condition": "trigger",
"id": "night"
}
],
"sequence": [
{
"service": "zwave_js.set_config_parameter",
"data": {
"parameter": "5",
"value": "15"
}
}
]
},
{
"conditions": [
{
"condition": "trigger",
"id": "day"
}
],
"sequence": [
{
"service": "zwave_js.set_config_parameter",
"data": {
"parameter": "5",
"value": 100
}
}
]
}
],
"default": []
}
],
"tags": {}
},
{
"metadata": {
"id": "alarmanlage_an",
"alias": "alarmanlage_an (Uhrzeit)",
"mode": "single"
},
tags: {},
"trigger": [
{
"entity_id": "sensor.time",
"platform": "state",
"to": "23:30"
}
],
"condition": [
{
"condition": "or",
"conditions": [
{
"condition": "state",
"entity_id": "person.simon",
"state": "home"
},
{
"condition": "state",
"entity_id": "person.leni",
"state": "home"
}
]
}
],
"sequence": [
{
"service": "alarm_control_panel.alarm_arm_night",
"target": {
"entity_id": [
"alarm_control_panel.alarmo"
]
},
"data": {
"code": "xxx"
}
},
{
"service": "alarm_control_panel.alarm_arm_away",
"data": {},
"target": {
"entity_id": "alarm_control_panel.blink_home"
}
}
],
}
],
}
export const BadAutmations = Template.bind({})
BadAutmations.args = {
...BadAutmations.args,
automations: [
{
condition: [],
tags: {},
metadata: {
id: "Bad Choose Sequence",
alias: "Bad Choose",
description: "Example Metadata",
trigger_variables: {
'wowo': '!'
},
mode: 'single',
},
trigger: [],
sequence: [
{
choose: {}
}
] as any
},
{
condition: [],
tags: {},
metadata: {
id: "random",
alias: "Bad Trigger",
description: "Example Metadata",
trigger_variables: {
'wowo': '!'
},
mode: 'single',
},
trigger: [
"haha I am a string"
] as any,
sequence: []
},
{
condition: [],
tags: {},
metadata: {
} as any,
trigger: [
],
sequence: []
}
],
}
@@ -1,6 +1,6 @@
import "./AutomationListBox.css";
import { FC, useState } from 'react';
import { AutomationData } from "types/automations";
import { AutomationData, AutomationMetadata } from "types/automations";
import InputMultiSelect from "components/Inputs/InputMultiSelect";
import InputText from "components/Inputs/InputText";
import { Button } from "components/Inputs/Button";
@@ -65,11 +65,14 @@ export const getTagList = (autos: AutomationData[]): string[] => Object.keys(aut
}, {}))
const filterAutomations = (autos: AutomationData[], searchText: string, selected: number[], tags: string[]): Array<[AutomationData, number]> => autos.map<[AutomationData, number]>((a, i) => [a, i]).filter(([a, i]) => {
if (!a.metadata) {
return true
}
if (searchText.length > 0) {
if (
!(
a.metadata.description.toLocaleLowerCase().includes(searchText) ||
a.metadata.alias.toLocaleLowerCase().includes(searchText)
(a.metadata.description ?? "").toLocaleLowerCase().includes(searchText) ||
(a.metadata.alias ?? "").toLocaleLowerCase().includes(searchText)
)
) {
return false
@@ -130,25 +133,17 @@ const convertGroupsToItems = (
if (Array.isArray(groups)) {
return groups.map(i => {
const [auto, autoIndex] = autos[i];
let title = "BadAuto<<Missing Metadata>>"
if (auto.metadata) {
title = `Name = ${auto.metadata.alias}\nID = ${auto.metadata.id}\nDescription = ${auto.metadata.description}`
}
return <div
key={i}
className={["automation-list-box--body--item", selected === autoIndex ? 'selected' : ''].join(' ')}
title={`Name = ${auto.metadata.alias}\nID = ${auto.metadata.id}\nDescription = ${auto.metadata.description}`}
title={title}
onClick={() => onSelectAutomation(autoIndex)}
>
<div
className="automation-list-box--body--item--title"
>
<b>{auto.metadata.alias.slice(0, 15)} <span>({auto.metadata.id.slice(0, 5)})</span></b>
<span>{auto.metadata.description.slice(0, 25)}</span>
<div
className="automation-list-box--body--item--tags"
>
{Object.keys(auto.tags).map(tagName => <span key={tagName}>
<b>{tagName}:</b> {auto.tags[tagName]}
</span>)}
</div>
</div>
<MetadataBox metadata={auto.metadata} tags={auto.tags} />
<Button onClick={() => onRemove(autoIndex)}><TrashIcon /></Button>
</div>
})
@@ -167,6 +162,31 @@ const convertGroupsToItems = (
}
}
export const MetadataBox: FC<{
metadata: AutomationMetadata,
tags: Record<string, string>,
}> = (auto) => {
let title = <span>{"BadAuto<<Missing Metadata>>"}</span>
if (auto.metadata) {
title = <>
<b>{String(auto.metadata.alias ?? "").slice(0, 15)} <span>({String(auto.metadata.id).slice(0, 5)})</span></b>
<span>{String(auto.metadata.description ?? "").slice(0, 25)}</span>
</>
}
return <div
className="automation-list-box--body--item--title"
>
{title}
<div
className="automation-list-box--body--item--tags"
>
{Object.keys(auto.tags).map(tagName => <span key={tagName}>
<b>{tagName}:</b> {auto.tags[tagName]}
</span>)}
</div>
</div>
}
const AutomationListBoxGroup: FC<{
groupName: string,
@@ -40,7 +40,7 @@ export const AutomationList: FC<AutomationListParams> = ({
<AutomationListBox
automations={automations}
onAdd={() => {
onAdd(defaultAutomation(`shortu-${automations.length}`));
onAdd(defaultAutomation(String(Date.now())));
setCurrent(automations.length)
}}
onSelectAutomation={i => {
+1 -1
View File
@@ -1,5 +1,5 @@
import { FC } from "react";
import { AddIcon, PencilIcon, TrashIcon } from '../Icons/index';
import { AddIcon, TrashIcon } from '../Icons/index';
import { useCircleStyles } from './styles';
import { Handle, Position, XYPosition } from 'react-flow-renderer';
@@ -1,5 +1,5 @@
import { makeFlowCircle } from "./DAGCircle"
import { DAGAutomationFlowDims, FlowData } from "./types"
import { DAGAutomationFlowDims } from "./types"
import { XYPosition } from 'react-flow-renderer';
export const makeAddButton = (
+13 -13
View File
@@ -20,7 +20,18 @@ const nodeTypes = {
'dagcircle': DAGCircle,
}
interface Props {
const makeOnEditAutomationConditions = (
conditions: AutomationCondition[],
updateConditions: (c: AutomationCondition[]) => void,
openModal: UpdateModalState,
) => () => openModal({
single: false,
node: conditions,
allowedTypes: ['condition'],
update: c => updateConditions(c as any),
})
export interface DAGAutomationFlowProps {
className?: string;
trigger: AutomationTrigger[];
condition: AutomationCondition[];
@@ -31,7 +42,7 @@ interface Props {
onConditionUpdate: (s: AutomationCondition[]) => void;
}
export const DAGAutomationFlow: FC<Props> = ({
export const DAGAutomationFlow: FC<DAGAutomationFlowProps> = ({
className,
trigger,
condition,
@@ -131,14 +142,3 @@ export const DAGAutomationFlow: FC<Props> = ({
</ReactFlow>
</>;
}
const makeOnEditAutomationConditions = (
conditions: AutomationCondition[],
updateConditions: (c: AutomationCondition[]) => void,
openModal: UpdateModalState,
) => () => openModal({
single: false,
node: conditions,
allowedTypes: ['condition'],
update: c => updateConditions(c as any),
})
+4
View File
@@ -0,0 +1,4 @@
.dag-flow-safe {
height: 100%;
overflow: scroll;
}
+84
View File
@@ -0,0 +1,84 @@
import "./safe.css";
import { Component, ErrorInfo } from "react";
import { DAGAutomationFlow, DAGAutomationFlowProps } from ".";
import { AutomationSequenceNode } from "types/automations";
import { AutomationCondition } from "types/automations/conditions";
import { AutomationTrigger } from 'types/automations/triggers';
import InputYaml from "components/Inputs/InputYaml";
import { Button } from "components/Inputs/Button";
type GoodState = {
hasError: false;
}
type FailedStateData = {
sequence: AutomationSequenceNode[],
condition: AutomationCondition[],
trigger: AutomationTrigger[],
}
type FailedState = {
hasError: true,
error: any,
errorInfo?: ErrorInfo,
} & FailedStateData
type State = GoodState | FailedState
export class SafeDAGAutomationFlow extends Component<DAGAutomationFlowProps, State> {
state: State = {
hasError: false
}
componentDidCatch(error: Error, errorInfo: ErrorInfo) {
this.setState({
hasError: true,
error,
errorInfo,
sequence: this.props.sequence,
condition: this.props.condition,
trigger: this.props.trigger,
})
}
render() {
if (this.state.hasError) {
const makeSet = <K extends keyof FailedStateData>(k: K) => (d: FailedStateData[K]) => this.setState({
...this.state,
[k]: d,
});
const makeSave = <K extends keyof FailedStateData>(k: K) => () => {
if (!this.state.hasError) {
return
}
if (k === 'condition') {
this.props.onConditionUpdate(this.state.condition)
} else if (k === 'sequence') {
this.props.onSequenceUpdate(this.state.sequence)
} else if (k === 'trigger') {
this.props.onTriggerUpdate(this.state.trigger)
}
}
return <div className="dag-flow-safe">
<h1>An Error has occured.</h1>
<h1>Failed to Open Autmation!</h1>
Something is likely not configured in your automation properly.
<hr />
<h2>Error:</h2>
<h2>{String(this.state.error)}</h2>
<br />
{JSON.stringify(this.state.error, null, 4)}
{this.state.errorInfo && this.state.errorInfo.componentStack.split('\n').map((s, i) => <>
<span key={i}>{s}</span><br key={`br-${i}`} />
</>)}
<h2>Automation YAML</h2>
<InputYaml resizable label="Trigger" value={this.state.trigger} onChange={makeSet('trigger')} />
<Button onClick={makeSave('trigger')}>Save Triggers</Button>
<InputYaml resizable label="Condition" value={this.state.condition} onChange={makeSet('condition')} />
<Button onClick={makeSave('condition')}>Save Conditions</Button>
<InputYaml resizable label="Action" value={this.state.sequence} onChange={makeSet('sequence')} />
<Button onClick={makeSave('sequence')}>Save Actions</Button>
</div>
}
return <DAGAutomationFlow {...this.props} />;
}
}
@@ -209,7 +209,7 @@ const addChooseNode = (
}, { size: dims.circleSize })
flowData.nodes.push(elseCircle)
addEdge(flowData, nodeId, elseCircle.id, true)
const lastPoint = sequenceToFlow(flowData, node.default, elseCircle.id, {
const lastPoint = sequenceToFlow(flowData, node.default ?? [], elseCircle.id, {
...dims,
padding: {
x: position.x - dims.nodeWidth,
@@ -1,6 +1,5 @@
import { AutomationTrigger } from 'types/automations/triggers';
import { DAGAutomationFlowDims, FlowData, TriggerMakerOptions } from './types';
import { makeFlowCircle } from './DAGCircle';
import { makeAddButton } from './flowDataMods';
export const triggerToFlow = (
@@ -14,7 +13,6 @@ export const triggerToFlow = (
distanceFactor,
nodeHeight,
nodeWidth,
circleSize,
padding,
conditionHeight,
} = dims;
+1 -1
View File
@@ -68,7 +68,7 @@ export const makeSequenceUpdater = (
)
} else {
return makeSequenceUpdater(
node.default,
node.default ?? [],
seq => this.updateNode(i, {
...node,
default: seq
@@ -1,5 +1,4 @@
import "./InputBoolean.css";
import InputWrapper from "./InputWrapper";
export interface Props {
label: string;
+10 -6
View File
@@ -1,14 +1,15 @@
import { PropsWithChildren, useState } from "react";
import { AutomationTime } from "types/automations/common";
import { AutomationTime, AutomationTimeObject } from "types/automations/common";
import { milisecondsToObject } from "utils/time";
import InputWrapper from "./InputWrapper";
import { useInputTimeStyles } from "./styles";
import { convertStringToAutomationTimeObject } from 'utils/time';
export interface Props {
textBoxFor?: string;
label: string;
value?: AutomationTime;
onChange: (v?: AutomationTime) => void;
onChange: (v?: AutomationTimeObject) => void;
onEnter?: () => void;
}
export default function InputTime({
@@ -21,11 +22,14 @@ export default function InputTime({
}: PropsWithChildren<Props>) {
let cleanValue = '';
if (value) {
if (typeof value === 'string') {
value = convertStringToAutomationTimeObject(value);
}
const {
hours,
minutes,
seconds,
milliseconds,
hours = 0,
minutes = 0,
seconds = 0,
milliseconds = 0,
} = value;
cleanValue = [hours, minutes, seconds].map(x => String(x).padStart(2, '0')).join(':') + `.${String(milliseconds).padStart(3, '0')}`;
}
+1 -1
View File
@@ -1,7 +1,7 @@
import * as yaml from "js-yaml";
import { useState } from "react";
import InputTextArea from "./InputTextArea";
import { useDelayedFunction, useDelayEffect } from 'utils/useDelay';
import { useDelayEffect } from 'utils/useDelay';
export interface Props<T extends {}> {
label: string;
@@ -11,6 +11,7 @@ export const TriggerDevice: OptionManager<AutomationTriggerDevice> = {
"type": "",
"subtype": "",
"device_id": "",
"entity_id": "",
}),
isReady: ({ alias }) => {
return (alias !== '')
@@ -33,6 +34,10 @@ export const TriggerDevice: OptionManager<AutomationTriggerDevice> = {
...state,
device_id
})} />
<InputText label="Entity" value={state.entity_id ?? ""} onChange={entity_id => setState({
...state,
entity_id
})} />
</>
}
}
@@ -1,13 +1,14 @@
import { OptionManager } from './OptionManager';
import { AutomationTriggerTime } from 'types/automations/triggers';
import InputTime from 'components/Inputs/InputTime';
import { convertObjectToAutomationTimeString } from 'utils/time';
export const TriggerTime: OptionManager<AutomationTriggerTime> = {
defaultState: () => ({
"alias": "",
"platform": 'time',
"at": {},
"at": "",
}),
isReady: ({ alias }) => {
return (alias !== '')
@@ -19,7 +20,7 @@ export const TriggerTime: OptionManager<AutomationTriggerTime> = {
value={state.at}
onChange={_at => setState({
...state,
at: _at ?? {},
at: _at ? convertObjectToAutomationTimeString(_at) : "00:00:00",
})}
/>
</>
@@ -8,10 +8,6 @@ import InputYaml from 'components/Inputs/InputYaml';
type UseState = <S>(s: S) => [S, Dispatch<SetStateAction<S>>]
const mockUseState: UseState = s => {
return [s, () => { }]
}
export const useEditorNodeState = (originalNode: AutomationNode, uState: UseState = useState) => {
const [allState, setAllState] = uState({
node: originalNode,
@@ -22,6 +18,7 @@ export const useEditorNodeState = (originalNode: AutomationNode, uState: UseStat
const { node: currentNode, isModified, yamlMode, invalidManualYaml } = allState;
useEffect(() => {
setAllState({ ...allState, node: originalNode, isModified: false, })
// eslint-disable-next-line
}, [originalNode])
const setState = (node: AutomationNode) => setAllState(({ ...allState, node, isModified: true, }));
const setYamlMode = (yamlMode: boolean) => setAllState({ ...allState, yamlMode, });
@@ -1,5 +1,4 @@
import { AutomationNodeSubtype, AutomationNodeTypes } from "types/automations";
import { ActionType } from "types/automations/actions";
import { AutomationNode } from '../../types/automations/index';
+2 -2
View File
@@ -9,7 +9,7 @@ type AutomationActionNodeBase<Data extends Object> = Data & {
export type ServiceAction = AutomationActionNodeBase<{
service: string;
target: any;
target?: any;
data: any;
}>
export type RepeatAction = AutomationActionNodeBase<{
@@ -38,7 +38,7 @@ export type ChooseAction = AutomationActionNodeBase<{
conditions: AutomationCondition[];
sequence: AutomationSequenceNode[];
}>;
default: AutomationSequenceNode[];
default?: AutomationSequenceNode[];
}>
export type AutomationAction =
| ServiceAction
+6 -6
View File
@@ -1,6 +1,6 @@
export interface AutomationTime {
hours?: number;
minutes?: number;
seconds?: number;
milliseconds?: number;
}
import * as st from 'superstruct'
import * as v from "types/validators/common";
export type AutomationTime = st.Infer<typeof v.AutomationTime>
export type AutomationTimeObject = st.Infer<typeof v.AutomationTimeObject>
export type AutomationTimeString = st.Infer<typeof v.AutomationTimeString>
+4 -8
View File
@@ -1,15 +1,11 @@
import * as st from 'superstruct'
import { ActionType, AutomationAction } from "./actions";
import { AutomationCondition, ConditionType } from "./conditions";
import { AutomationTrigger, TriggerType } from "./triggers";
import * as mv from "types/validators/metadata";
export interface AutomationMetadata {
id: string;
alias: string;
description: string;
trigger_variables?: Record<string, string>;
mode: "single" | "restart" | "queued" | "parallel";
}
export type AutomationMetadata = st.Infer<typeof mv.AutomationMetadata>
export interface AutomationData {
metadata: AutomationMetadata;
trigger: AutomationTrigger[];
+15 -70
View File
@@ -1,79 +1,24 @@
import * as st from 'superstruct'
import { AutomationTime } from "./common";
import * as v from "types/validators/triggers";
interface AutomationTriggerBase {
alias?: string;
}
export interface AutomationTriggerEvent extends AutomationTriggerBase {
platform: 'event';
event_type: string | string[];
event_data?: any;
context?: any;
}
export interface AutomationTriggerHA extends AutomationTriggerBase {
platform: 'homeassistant';
event: 'start' | 'shutdown';
}
export interface AutomationTriggerMQTT extends AutomationTriggerBase {
platform: 'mqtt';
topic: string;
payload: string;
value_template: string;
}
export interface AutomationTriggerNumericState extends AutomationTriggerBase {
platform: 'numeric_state';
entity_id: string | string[];
attribute?: string;
value_template?: string;
above?: string;
below?: string;
for?: AutomationTime;
}
export interface AutomationTriggerState extends AutomationTriggerBase {
platform: 'state';
entity_id: string | string[];
attribute?: string;
from?: string;
to?: string;
for?: AutomationTime;
}
export interface AutomationTriggerTag extends AutomationTriggerBase {
platform: 'tag';
tag_id: string;
device_id: string | string[];
}
export interface AutomationTriggerTemplate extends AutomationTriggerBase {
platform: 'template';
value_template: string;
for?: AutomationTime;
}
export interface AutomationTriggerTime extends AutomationTriggerBase {
platform: 'time';
at: AutomationTime;
}
export interface AutomationTriggerTimePattern extends AutomationTriggerBase {
platform: 'time_pattern';
hours?: string;
minutes?: string;
seconds?: string;
}
export interface AutomationTriggerWebhook extends AutomationTriggerBase {
platform: 'webhook';
webhook_id: string;
}
export interface AutomationTriggerZone extends AutomationTriggerBase {
platform: 'zone';
entity_id: string | string[];
zone: string;
event: 'enter' | 'leave';
}
export interface AutomationTriggerDevice extends AutomationTriggerBase {
platform: 'device';
device_id: string;
domain: string;
type: string;
subtype: string;
}
export type AutomationTriggerEvent = st.Infer<typeof v.AutomationTriggerEvent>;
export type AutomationTriggerHA = st.Infer<typeof v.AutomationTriggerHA>;
export type AutomationTriggerMQTT = st.Infer<typeof v.AutomationTriggerMQTT>;
export type AutomationTriggerNumericState = st.Infer<typeof v.AutomationTriggerNumericState>;
export type AutomationTriggerState = st.Infer<typeof v.AutomationTriggerState>;
export type AutomationTriggerTag = st.Infer<typeof v.AutomationTriggerTag>;
export type AutomationTriggerTemplate = st.Infer<typeof v.AutomationTriggerTemplate>;
export type AutomationTriggerTime = st.Infer<typeof v.AutomationTriggerTime>;
export type AutomationTriggerTimePattern = st.Infer<typeof v.AutomationTriggerTimePattern>;
export type AutomationTriggerWebhook = st.Infer<typeof v.AutomationTriggerWebhook>;
export type AutomationTriggerZone = st.Infer<typeof v.AutomationTriggerZone>;
export type AutomationTriggerDevice = st.Infer<typeof v.AutomationTriggerDevice>;
export type AutomationTrigger =
| AutomationTriggerEvent
| AutomationTriggerHA
+24
View File
@@ -0,0 +1,24 @@
import * as st from 'superstruct'
const AutomationActionNodeBase = {
alias: st.optional(st.string()),
variables: st.optional(st.record(st.string(), st.any())),
}
export const ServiceAction = st.object({
...AutomationActionNodeBase,
data: st.any(),
target: st.any(),
service: st.string(),
})
export const RepeatAction = st.object({
...AutomationActionNodeBase,
repeat: st.object({
count: st.number(),
sequence: st.array(),
})
})
+11
View File
@@ -0,0 +1,11 @@
import * as st from 'superstruct'
import { AutomationMetadata } from './metadata'
export const AutomationData = st.object({
metadata: AutomationMetadata,
trigger: st.array(st.object()),
condition: st.array(st.object()),
sequence: st.array(st.object()),
tags: st.record(st.string(), st.string()),
})
+35
View File
@@ -0,0 +1,35 @@
import * as st from 'superstruct'
export const AutomationTimeString = st.refine(st.string(), 'TimeString', (v, c) => {
// https://www.home-assistant.io/docs/automation/trigger/#time-string
const bits: string[] = v.split(':')
if ((bits.length !== 2) && (bits.length !== 3)) {
return {
"branch": c.branch,
"message": "Time string should be either in the form 'HH:MM' or 'HH:MM:SS' as specified in https://www.home-assistant.io/docs/automation/trigger/#time-string",
"path": c.path,
}
}
for (let i = 0; i < bits.length; i++) {
const b = bits[i];
const num = Number(b);
if (!Number.isInteger(num) || (num < 0) || (num > 23)) {
return {
"branch": c.branch,
"message": "Time string should contain only positive numbers between 0-23 as specified in https://www.home-assistant.io/docs/automation/trigger/#time-string",
"path": c.path.concat(
bits.slice(0, i)
).concat([`<<${b}>>`])
}
}
}
return true
})
export const AutomationTimeObject = st.object({
hours: st.optional(st.number()),
minutes: st.optional(st.number()),
seconds: st.optional(st.number()),
milliseconds: st.optional(st.number()),
});
export const AutomationTime = st.union([st.string(), AutomationTimeObject])
+31
View File
@@ -0,0 +1,31 @@
import * as st from 'superstruct';
export type MiniFailure = {
path: string,
message: string[],
}
export const getFailures = <T, S>(value: unknown, struct: st.Struct<T, S>): MiniFailure[] | null => {
try {
st.assert(value, struct)
} catch (err) {
if (err instanceof st.StructError) {
const failureMap = err.failures().reduce((all: Record<string, Set<string>> = {}, next) => {
const path = next.path.join('.');
if (all[path]) {
all[path].add(next.message)
} else {
all[path] = new Set([next.message])
}
return all
}, {})
return Object.keys(failureMap).map((path) => ({
path,
message: Array.from(failureMap[path].values())
}))
}
throw err
}
return null
}
+55
View File
@@ -0,0 +1,55 @@
import * as st from "superstruct";
import { AutomationMetadata } from "./metadata";
import { AutomationData } from './autmation';
import { getFailures } from './helper';
import { AutomationTimeString } from "./common";
test('superstructure is', () => {
const badCheck = st.is({}, AutomationMetadata);
expect(badCheck).toBeFalsy()
})
test('getFailures returns failures', () => {
const failures = getFailures({ metadata: {} }, AutomationData);
expect(failures).toHaveLength(6)
})
test('getFailures returns null', () => {
const failures = getFailures({
id: "test",
alias: "hey",
description: "wow",
mode: "single",
}, AutomationMetadata);
expect(failures).toBeNull()
})
test('AutomationTimeString is valid', () => {
for (const c of [
'10:23',
'15:02',
'13:00:1',
'23:00:23'
]) {
const failures = getFailures(c, AutomationTimeString)
expect(failures).toBeNull()
}
})
test('AutomationTimeString is invalid', () => {
for (const c of [
'xx:23',
'1x:02',
'13:0a:1c',
'25:00:23',
'11'
]) {
const failures = getFailures({
"time": c
}, st.object({
time: AutomationTimeString,
}))
expect(failures).toHaveLength(1)
}
})
+10
View File
@@ -0,0 +1,10 @@
import * as st from 'superstruct'
export const AutomationMetadata = st.object({
id: st.string(),
alias: st.optional(st.string()),
description: st.optional(st.string()),
trigger_variables: st.optional(st.nullable(st.record(st.string(), st.string()))),
mode: st.enums(["single", "restart", "queued", "parallel"]),
})
+119
View File
@@ -0,0 +1,119 @@
import * as st from 'superstruct'
import { AutomationTimeString, AutomationTime } from './common'
const AutomationTriggerBase = {
alias: st.optional(st.string()),
id: st.optional(st.string()),
}
export const AutomationTriggerEvent = st.object({
...AutomationTriggerBase,
platform: st.literal('event'),
event_type: st.union([st.string(), st.array(st.string())]),
event_data: st.any(),
context: st.any(),
})
export const AutomationTriggerHA = st.object({
...AutomationTriggerBase,
platform: st.literal('homeassistant'),
event: st.enums(['start', 'shutdown']),
})
export const AutomationTriggerMQTT = st.object({
...AutomationTriggerBase,
platform: st.literal('mqtt'),
topic: st.string(),
payload: st.string(),
value_template: st.string(),
})
export const AutomationTriggerNumericState = st.object({
...AutomationTriggerBase,
platform: st.literal('numeric_state'),
entity_id: st.union([st.string(), st.array(st.string())]),
attribute: st.optional(st.string()),
value_template: st.optional(st.string()),
above: st.optional(st.string()),
below: st.optional(st.string()),
for: st.optional(AutomationTime),
})
export const AutomationTriggerState = st.object({
...AutomationTriggerBase,
platform: st.literal('state'),
entity_id: st.union([st.string(), st.array(st.string())]),
attribute: st.optional(st.string()),
from: st.optional(st.string()),
to: st.optional(st.string()),
for: st.optional(AutomationTime),
})
export const AutomationTriggerTag = st.object({
...AutomationTriggerBase,
platform: st.literal('tag'),
tag_id: st.string(),
device_id: st.union([st.string(), st.array(st.string())]),
})
export const AutomationTriggerTemplate = st.object({
...AutomationTriggerBase,
platform: st.literal('template'),
value_template: st.string(),
for: st.optional(AutomationTime),
})
export const AutomationTriggerTime = st.object({
...AutomationTriggerBase,
platform: st.literal('time'),
at: AutomationTimeString,
})
export const AutomationTriggerTimePattern = st.object({
...AutomationTriggerBase,
platform: st.literal('time_pattern'),
hours: st.optional(st.string()),
minutes: st.optional(st.string()),
seconds: st.optional(st.string()),
})
export const AutomationTriggerWebhook = st.object({
...AutomationTriggerBase,
platform: st.literal('webhook'),
webhook_id: st.string(),
})
export const AutomationTriggerZone = st.object({
...AutomationTriggerBase,
platform: st.literal('zone'),
entity_id: st.union([st.string(), st.array(st.string())]),
zone: st.string(),
event: st.enums(['enter', 'leave'])
})
export const AutomationTriggerDevice = st.object({
...AutomationTriggerBase,
platform: st.literal('device'),
entity_id: st.optional(st.string()),
device_id: st.string(),
domain: st.string(),
type: st.string(),
subtype: st.optional(st.string()),
})
export const AutomationTrigger = st.union([
AutomationTriggerEvent,
AutomationTriggerHA,
AutomationTriggerMQTT,
AutomationTriggerNumericState,
AutomationTriggerState,
AutomationTriggerTag,
AutomationTriggerTemplate,
AutomationTriggerTime,
AutomationTriggerTimePattern,
AutomationTriggerWebhook,
AutomationTriggerZone,
AutomationTriggerDevice
])
+13 -7
View File
@@ -2,13 +2,19 @@ import { AutomationNode, AutomationNodeTypes } from "types/automations";
import { AutomationTime } from "types/automations/common";
export const convertTimeToString = ({
hours = 0,
minutes = 0,
seconds = 0,
milliseconds = 0,
}: AutomationTime) => [hours, minutes, seconds, milliseconds].map(n => String(n).padStart(2, '0')).join(':')
export const convertTimeToString = (t: AutomationTime) => {
if (typeof t === 'string') {
return t
} else {
const {
hours = 0,
minutes = 0,
seconds = 0,
milliseconds = 0,
} = t
return [hours, minutes, seconds, milliseconds].map(n => String(n).padStart(2, '0')).join(':')
}
}
export const getDescriptionFromAutomationNode = <N extends AutomationNodeTypes>(node: AutomationNode<N>): string => {
if (node.alias) {
return node.alias;
+20 -2
View File
@@ -1,8 +1,8 @@
import { AutomationTime } from "types/automations/common";
import { AutomationTimeObject, AutomationTimeString } from "types/automations/common";
const cleanTime = (t: number) => Math.max(0, Math.floor(t))
export const milisecondsToObject = (total_miliseconds: number): AutomationTime => {
export const milisecondsToObject = (total_miliseconds: number): AutomationTimeObject => {
const hours = cleanTime(total_miliseconds / (60 * 60 * 1000));
const minutes = cleanTime((total_miliseconds - hours * 60 * 60 * 1000) / (60 * 1000));
const seconds = cleanTime((total_miliseconds - hours * 60 * 60 * 1000 - minutes * 60 * 1000) / 1000);
@@ -10,4 +10,22 @@ export const milisecondsToObject = (total_miliseconds: number): AutomationTime =
return {
hours, minutes, seconds, milliseconds,
}
}
export const convertStringToAutomationTimeObject = (t: AutomationTimeString): AutomationTimeObject => {
const bits = t.split(':')
return {
hours: Number(bits[0]),
minutes: Number(bits[1]),
seconds: bits.length === 3 ? Number(bits[2]) : 0,
}
}
export const convertObjectToAutomationTimeString = (t: AutomationTimeObject): AutomationTimeString => {
const {
hours = 0,
minutes = 0,
seconds = 0
} = t
return [hours, minutes, seconds].map(x => String(x).padStart(2, '0')).join(':')
}
+2 -1
View File
@@ -5,7 +5,8 @@ export const useDelayEffect = (cb: () => void, deps: any[], timeout: number) =>
const fcn = useDelayedFunction(cb, timeout);
useEffect(() => {
fcn()
}, [deps])
// eslint-disable-next-line
}, deps)
}
export const useDelayedFunction = <FcnParams extends any[]>(
+1 -3
View File
@@ -16,8 +16,6 @@ export default function useWindowSize(mobileRatioInd: number = 0.8): Size {
const [windowSize, setWindowSize] = useState<Size>(makeUpdate(window, mobileRatioInd));
// alias
useEffect(() => {
// Handler to call on window resize
function handleResize() {
@@ -33,7 +31,7 @@ export default function useWindowSize(mobileRatioInd: number = 0.8): Size {
// Remove event listener on cleanup
return () => window.removeEventListener("resize", handleResize);
}, []); // Empty array ensures that effect is only run on mount
}, [mobileRatioInd]); // Empty array ensures that effect is only run on mount
return windowSize;
}
+5
View File
@@ -15937,6 +15937,11 @@ stylehacks@^4.0.0:
postcss "^7.0.0"
postcss-selector-parser "^3.0.0"
superstruct@^0.15.4:
version "0.15.4"
resolved "https://registry.yarnpkg.com/superstruct/-/superstruct-0.15.4.tgz#e3381dd84ca07e704e19f69eda74eee1a5efb1f9"
integrity sha512-eOoMeSbP9ZJChNOm/9RYjE+F36rYR966AAqeG3xhQB02j2sfAUXDp4EQ/7bAOqnlJnuFDB8yvOu50SocvKpUEw==
supports-color@^5.3.0:
version "5.5.0"
resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-5.5.0.tgz#e2e69a44ac8772f78a1ec0b35b689df6530efc8f"