Add Blueprint Editor

[jpitlor]

Proposed change

I wanted to add an editor for Blueprints, similar to Automations and Scripts. Essentially, this creates a page that has an editor for blueprintObject.metadata.input, then embeds the existing automation/script editor.

There was a WTH forum post asking for this. I'm not sure if there were any formal feature requests/roadmap plans, but truthfully this is mostly inspired by my own desire for this feature to exist.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New feature (thank you!)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Example configuration

I don't think any particular configuration is needed to test this, especially since HA comes with a couple blueprints out of the box.

Additional information

• This PR fixes or closes issue: N/A
• This PR is related to issue or discussion: https://community.home-assistant.io/t/wth-cant-we-create-or-edit-blueprints-with-the-ui/469776/5
• Link to documentation pull request: Add Blueprint Editor home-assistant.io#39316
• Link to core pull request: Add Blueprint Editor core#145863

Additionally, I have concerns about the size of this MR. I think it's quite large. If it should be broken up, I'd love to do that. I just need guidance on the best strategy. However, there are parts of this feature I left out explicitly because of the size:

• a /show route
• Adding support for !inputs in visual selectors
• Selector Configuration Implemented, thanks to feedback from karwosts!
• Validation/testing (of the blueprints, not the code)

Checklist

• The code change is tested and works locally.
• There is no commented out code in this PR.
• Tests have been added to verify that the new code works. I did not do this because it doesn't seem like there's a way to test UI components. At least, I didn't see anything in the test directory. Let me know if there's something I can look at!

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

[home-assistant]

Hi @jpitlor

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

[home-assistant]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Stale

[NoRi2909]

We need sentence-casing on these strings and a bunch more below.

"edit_ui": "UI editor",
"edit_yaml": "YAML editor",

"delete_confirm_title": "Delete input",

"change_id": "Change input ID",

"default": "Default value",

"add_description": "Add description",
"add_author": "Add author",
"add_minimum_version": "Add minimum version"

"label": "Minimum version",

I may have missed another one.

[jpitlor]

will do! I'll double check all of the ones I added. Is the general guidance to use sentence casing on everything? Or are there any exceptions?

[NoRi2909]

Yes, Home Assistant uses sentence-casing in general. It helps translators like me to see what can be translated and what is a (capitalized) name or abbreviation that we should keep in translations.

[jpitlor]

That makes sense! Thanks for pointing it out. I'll try to get to this some time today

[jpitlor]

I looked at all the changes, and the nine you pointed out were the only ones I saw. Fixed!

[jpitlor]

Remembered to make sure it built, but forgot to lint locally! There were a couple errors in files I didn't touch, so I just left those as they are!

[silamon]

I've done a test run on this one and it work pretty well but I'm a bit thinking about how it will be used by home assistant users that don't manage the original blueprint.

The definition behind blueprints is that people can share them and other people can import them to use them in their home assistant installation. If there are updates to the blueprint, you can redownload it from the location you've initially downloaded them. If the user thinks that the blueprint doesn't fit their use-case completely and wants to modify it, they must take control and get a regular automation or script they can modify.

The blueprint editor introduced here, is just extending the regular blueprint area. The gap between people that develop blueprints and people that use blueprints is pretty close. People that don't manage the blueprint will just start editing the blueprint in the handy editor, having a modified version to their likings which will overwrite the original blueprint straightaway without warning, and they won't know anymore after a few months and they'll lose their changes when the blueprint will be updated by them.

TLDR; I think this nice blueprint editor may be a better fit under the developer tools.

[jpitlor]

Thanks for taking a look! Yeah that's completely fair - I didn't even realize you could update blueprints, so I agree that the developer tools is probably a better fit for this. I would still be satisfied - an editor in the developer tools is still better than no editor.

I can move it there, although I'm out of town this week, so it probably won't happen until some time next week

[jpitlor]

Thanks for the patience - I'm just now getting time to make progress on this again

@silamon as I'm moving the editor to the developer tools, I'm trying to think of how it should be used and I'd love to have your input since you know how people use this feature better than I do.

I'm assuming a UI editor that spits out the corresponding YAML to create a blueprint and then copy it over to GitHub (or wherever people put their blueprints) has a high likelihood of being valuable, especially since it mimics the purpose of the template tab.

I'm also assuming the ability to add your own blueprints may be valuable, as maybe people want to create their own blueprint, but they don't want to go through the effort of hosting them somewhere. Does this break any part of the blueprint page if the blueprint doesn't have an associated URL for updates?

And then there's the ability to edit existing blueprints - should I just leave this part out, or should I put it in with some warning dialog to add friction and make sure people know what they're doing?

[silamon]

That need some thinking. Since I'm just a voluntary reviewer I may wait for feedback from the Nabu Casa team.

[jpitlor]

That's fair - I'm just going to add all three until someone tells me otherwise