feat: add option to duplicate existing lighting instance (#1329)

* feat: add option to duplicate existing lighting instance

A menu step in the config flow was added that allows a user to create a
new instance or duplicate the options of an existing one.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add type annotation, tests, and translations for duplicate feature

- Add type annotation for source_options class attribute
- Add menu step translations to en.json
- Add tests for menu display, new instance creation, and duplication

* Simplify source_options access with class-level default

---------
Co-authored-by: Bas Nijholt <bas@nijho.lt>

custom_components/adaptive_lighting/config_flow.py

@@ -27,14 +27,49 @@ class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
 
     VERSION = 1
 
+    source_options: dict[str, Any] | None = None
+
     async def async_step_user(self, user_input: dict[str, Any] | None = None):
         """Handle the initial step."""
+        if user_input is None and self._async_current_entries():
+            return await self.async_step_menu()
+        return await self.async_step_wait_for_name(user_input)
+
+    async def async_step_menu(self, user_input: dict[str, Any] | None = None):
+        """Handle the menu step."""
+        if user_input is not None:
+            if user_input["action"] != "new":
+                entry_id = user_input["action"]
+                entry = self.hass.config_entries.async_get_entry(entry_id)
+                if entry:
+                    self.source_options = dict(entry.options)
+            return await self.async_step_wait_for_name()
+
+        entries = self._async_current_entries()
+        options = {"new": "Create new instance"}
+        for entry in entries:
+            options[entry.entry_id] = f"Duplicate '{entry.title}'"
+
+        return self.async_show_form(
+            step_id="menu",
+            data_schema=vol.Schema(
+                {vol.Required("action", default="new"): vol.In(options)},
+            ),
+        )
+
+    async def async_step_wait_for_name(self, user_input: dict[str, Any] | None = None):
+        """Handle the name step."""
         errors: dict[str, str] = {}
 
         if user_input is not None:
             await self.async_set_unique_id(user_input[CONF_NAME])
             self._abort_if_unique_id_configured()
-            return self.async_create_entry(title=user_input[CONF_NAME], data=user_input)
+            options = self.source_options
+            return self.async_create_entry(
+                title=user_input[CONF_NAME],
+                data=user_input,
+                options=options,
+            )
 
         return self.async_show_form(
             step_id="user",

custom_components/adaptive_lighting/strings.json

@@ -7,6 +7,13 @@
         "data": {
           "name": "Name"
         }
+      },
+      "menu": {
+        "title": "Create or Duplicate",
+        "description": "Do you want to create a new instance or duplicate an existing one?",
+        "data": {
+          "action": "Action"
+        }
       }
     },
     "abort": {

custom_components/adaptive_lighting/translations/en.json

@@ -8,6 +8,13 @@
         "data": {
           "name": "Name"
         }
+      },
+      "menu": {
+        "title": "Create or Duplicate",
+        "description": "Do you want to create a new instance or duplicate an existing one?",
+        "data": {
+          "action": "Action"
+        }
       }
     },
     "abort": {