feat: Ensure consistent ordering device definitions

automation_devices/src/lib.rs

@@ -70,13 +70,35 @@ pub fn create_module(lua: &mlua::Lua) -> mlua::Result<mlua::Table> {
     Ok(devices)
 }
 
-type RegisterTypeFn = fn() -> Option<String>;
+type TypeNameFn = fn() -> String;
+type TypeDefinitionFn = fn() -> Option<String>;
 
-pub struct RegisteredType(RegisterTypeFn);
+pub struct RegisteredType {
+    name_fn: TypeNameFn,
+    definition_fn: TypeDefinitionFn,
+}
+
+impl RegisteredType {
+    pub const fn new(name_fn: TypeNameFn, definition_fn: TypeDefinitionFn) -> Self {
+        Self {
+            name_fn,
+            definition_fn,
+        }
+    }
+
+    pub fn get_name(&self) -> String {
+        (self.name_fn)()
+    }
+
+    pub fn register(&self) -> Option<String> {
+        (self.definition_fn)()
+    }
+}
 
 macro_rules! register_type {
     ($ty:ty) => {
-        ::inventory::submit!(crate::RegisteredType(
+        ::inventory::submit!(crate::RegisteredType::new(
+            <$ty as ::lua_typed::Typed>::type_name,
             <$ty as ::lua_typed::Typed>::generate_full
         ));
     };
@@ -88,9 +110,12 @@ inventory::collect!(RegisteredType);
 fn generate_definitions() -> String {
     let mut output = String::new();
 
+    let mut types: Vec<_> = inventory::iter::<RegisteredType>.into_iter().collect();
+    types.sort_by_key(|ty| ty.get_name());
+
     output += "---@meta\n\nlocal devices\n\n";
-    for ty in inventory::iter::<RegisteredType> {
+    for ty in types {
-        if let Some(def) = ty.0() {
+        if let Some(def) = (ty.definition_fn)() {
             output += &(def + "\n");
         } else {
             // NOTE: Due to how this works the typed is erased, so we don't know the cause

definitions/automation:devices.lua

@@ -3,17 +3,13 @@
 
 local devices
 
----@class KasaOutletConfig
+---@class Action
----@field identifier string
+---@field action
----@field ip string
+---| "broadcast"
-local KasaOutletConfig
+---@field extras table<string, string>?
-
+---@field label string
----@class KasaOutlet: DeviceInterface, OnOffInterface
+---@field clear boolean?
-local KasaOutlet
+local Action
-devices.KasaOutlet = {}
----@param config KasaOutletConfig
----@return KasaOutlet
-function devices.KasaOutlet.new(config) end
 
 ---@class AirFilter: DeviceInterface, OnOffInterface
 local AirFilter
@@ -28,21 +24,73 @@ function devices.AirFilter.new(config) end
 ---@field url string
 local AirFilterConfig
 
----@class Presence: DeviceInterface
+---@class ConfigLightLightStateBrightness
-local Presence
+---@field name string
-devices.Presence = {}
+---@field room string?
----@param config PresenceConfig
----@return Presence
-function devices.Presence.new(config) end
----@async
----@return boolean
-function Presence:overall_presence() end
-
----@class PresenceConfig
 ---@field topic string
----@field callback fun(_: Presence, _: boolean) | fun(_: Presence, _: boolean)[]?
+---@field callback fun(_: LightBrightness, _: LightStateBrightness) | fun(_: LightBrightness, _: LightStateBrightness)[]?
+---@field client AsyncClient?
+local ConfigLightLightStateBrightness
+
+---@class ConfigLightLightStateColorTemperature
+---@field name string
+---@field room string?
+---@field topic string
+---@field callback fun(_: LightColorTemperature, _: LightStateColorTemperature) | fun(_: LightColorTemperature, _: LightStateColorTemperature)[]?
+---@field client AsyncClient?
+local ConfigLightLightStateColorTemperature
+
+---@class ConfigLightLightStateOnOff
+---@field name string
+---@field room string?
+---@field topic string
+---@field callback fun(_: LightOnOff, _: LightStateOnOff) | fun(_: LightOnOff, _: LightStateOnOff)[]?
+---@field client AsyncClient?
+local ConfigLightLightStateOnOff
+
+---@class ConfigOutletOutletStateOnOff
+---@field name string
+---@field room string?
+---@field topic string
+---@field outlet_type OutletType?
+---@field callback fun(_: OutletOnOff, _: OutletStateOnOff) | fun(_: OutletOnOff, _: OutletStateOnOff)[]?
 ---@field client AsyncClient
-local PresenceConfig
+local ConfigOutletOutletStateOnOff
+
+---@class ConfigOutletOutletStatePower
+---@field name string
+---@field room string?
+---@field topic string
+---@field outlet_type OutletType?
+---@field callback fun(_: OutletPower, _: OutletStatePower) | fun(_: OutletPower, _: OutletStatePower)[]?
+---@field client AsyncClient
+local ConfigOutletOutletStatePower
+
+---@class ContactSensor: DeviceInterface, OpenCloseInterface
+local ContactSensor
+devices.ContactSensor = {}
+---@param config ContactSensorConfig
+---@return ContactSensor
+function devices.ContactSensor.new(config) end
+
+---@class ContactSensorConfig
+---@field name string
+---@field room string?
+---@field topic string
+---@field sensor_type SensorType?
+---@field callback fun(_: ContactSensor, _: boolean) | fun(_: ContactSensor, _: boolean)[]?
+---@field battery_callback fun(_: ContactSensor, _: number) | fun(_: ContactSensor, _: number)[]?
+---@field client AsyncClient?
+local ContactSensorConfig
+
+---@alias Flag
+---| "presence"
+---| "darkness"
+
+---@class FlagIDs
+---@field presence integer
+---@field darkness integer
+local FlagIDs
 
 ---@class HueBridge: DeviceInterface
 local HueBridge
@@ -55,11 +103,6 @@ function devices.HueBridge.new(config) end
 ---@param value boolean
 function HueBridge:set_flag(flag, value) end
 
----@class FlagIDs
----@field presence integer
----@field darkness integer
-local FlagIDs
-
 ---@class HueBridgeConfig
 ---@field identifier string
 ---@field ip string
@@ -67,49 +110,6 @@ local FlagIDs
 ---@field flags FlagIDs
 local HueBridgeConfig
 
----@alias Flag
----| "presence"
----| "darkness"
-
----@class WasherConfig
----@field identifier string
----@field topic string
----@field threshold number
----@field done_callback fun(_: Washer) | fun(_: Washer)[]?
----@field client AsyncClient
-local WasherConfig
-
----@class Washer: DeviceInterface
-local Washer
-devices.Washer = {}
----@param config WasherConfig
----@return Washer
-function devices.Washer.new(config) end
-
----@class LightSensor: DeviceInterface
-local LightSensor
-devices.LightSensor = {}
----@param config LightSensorConfig
----@return LightSensor
-function devices.LightSensor.new(config) end
-
----@class LightSensorConfig
----@field identifier string
----@field topic string
----@field min integer
----@field max integer
----@field callback fun(_: LightSensor, _: boolean) | fun(_: LightSensor, _: boolean)[]?
----@field client AsyncClient
-local LightSensorConfig
-
----@class HueGroupConfig
----@field identifier string
----@field ip string
----@field login string
----@field group_id integer
----@field scene_id string
-local HueGroupConfig
-
 ---@class HueGroup: DeviceInterface, OnOffInterface
 local HueGroup
 devices.HueGroup = {}
@@ -117,203 +117,13 @@ devices.HueGroup = {}
 ---@return HueGroup
 function devices.HueGroup.new(config) end
 
----@class IkeaRemote: DeviceInterface
+---@class HueGroupConfig
-local IkeaRemote
+---@field identifier string
-devices.IkeaRemote = {}
+---@field ip string
----@param config IkeaRemoteConfig
+---@field login string
----@return IkeaRemote
+---@field group_id integer
-function devices.IkeaRemote.new(config) end
+---@field scene_id string
-
+local HueGroupConfig
----@class IkeaRemoteConfig
----@field name string
----@field room string?
----@field single_button boolean?
----@field topic string
----@field client AsyncClient
----@field callback fun(_: IkeaRemote, _: boolean) | fun(_: IkeaRemote, _: boolean)[]?
----@field battery_callback fun(_: IkeaRemote, _: number) | fun(_: IkeaRemote, _: number)[]?
-local IkeaRemoteConfig
-
----@class WolConfig
----@field name string
----@field room string?
----@field topic string
----@field mac_address string
----@field broadcast_ip string?
----@field client AsyncClient
-local WolConfig
-
----@class WakeOnLAN: DeviceInterface
-local WakeOnLAN
-devices.WakeOnLAN = {}
----@param config WolConfig
----@return WakeOnLAN
-function devices.WakeOnLAN.new(config) end
-
----@class ConfigOutletOutletStateOnOff
----@field name string
----@field room string?
----@field topic string
----@field outlet_type OutletType?
----@field callback fun(_: OutletOnOff, _: OutletStateOnOff) | fun(_: OutletOnOff, _: OutletStateOnOff)[]?
----@field client AsyncClient
-local ConfigOutletOutletStateOnOff
-
----@class OutletStatePower
----@field state boolean
----@field power number
-local OutletStatePower
-
----@class ConfigOutletOutletStatePower
----@field name string
----@field room string?
----@field topic string
----@field outlet_type OutletType?
----@field callback fun(_: OutletPower, _: OutletStatePower) | fun(_: OutletPower, _: OutletStatePower)[]?
----@field client AsyncClient
-local ConfigOutletOutletStatePower
-
----@alias OutletType
----| "Outlet"
----| "Kettle"
-
----@class OutletStateOnOff
----@field state boolean
-local OutletStateOnOff
-
----@class OutletOnOff: DeviceInterface, OnOffInterface
-local OutletOnOff
-devices.OutletOnOff = {}
----@param config ConfigOutletOutletStateOnOff
----@return OutletOnOff
-function devices.OutletOnOff.new(config) end
-
----@class OutletPower: DeviceInterface, OnOffInterface
-local OutletPower
-devices.OutletPower = {}
----@param config ConfigOutletOutletStatePower
----@return OutletPower
-function devices.OutletPower.new(config) end
-
----@class ContactSensorConfig
----@field name string
----@field room string?
----@field topic string
----@field sensor_type SensorType?
----@field callback fun(_: ContactSensor, _: boolean) | fun(_: ContactSensor, _: boolean)[]?
----@field battery_callback fun(_: ContactSensor, _: number) | fun(_: ContactSensor, _: number)[]?
----@field client AsyncClient?
-local ContactSensorConfig
-
----@alias SensorType
----| "Door"
----| "Drawer"
----| "Window"
-
----@class ContactSensor: DeviceInterface, OpenCloseInterface
-local ContactSensor
-devices.ContactSensor = {}
----@param config ContactSensorConfig
----@return ContactSensor
-function devices.ContactSensor.new(config) end
-
----@class LightStateOnOff
----@field state boolean
-local LightStateOnOff
-
----@class ConfigLightLightStateColorTemperature
----@field name string
----@field room string?
----@field topic string
----@field callback fun(_: LightColorTemperature, _: LightStateColorTemperature) | fun(_: LightColorTemperature, _: LightStateColorTemperature)[]?
----@field client AsyncClient?
-local ConfigLightLightStateColorTemperature
-
----@class LightStateBrightness
----@field state boolean
----@field brightness number
-local LightStateBrightness
-
----@class LightStateColorTemperature
----@field state boolean
----@field brightness number
----@field color_temp integer
-local LightStateColorTemperature
-
----@class LightBrightness: DeviceInterface, OnOffInterface, BrightnessInterface
-local LightBrightness
-devices.LightBrightness = {}
----@param config ConfigLightLightStateBrightness
----@return LightBrightness
-function devices.LightBrightness.new(config) end
-
----@class LightColorTemperature: DeviceInterface, OnOffInterface, BrightnessInterface, ColorSettingInterface
-local LightColorTemperature
-devices.LightColorTemperature = {}
----@param config ConfigLightLightStateColorTemperature
----@return LightColorTemperature
-function devices.LightColorTemperature.new(config) end
-
----@class ConfigLightLightStateOnOff
----@field name string
----@field room string?
----@field topic string
----@field callback fun(_: LightOnOff, _: LightStateOnOff) | fun(_: LightOnOff, _: LightStateOnOff)[]?
----@field client AsyncClient?
-local ConfigLightLightStateOnOff
-
----@class ConfigLightLightStateBrightness
----@field name string
----@field room string?
----@field topic string
----@field callback fun(_: LightBrightness, _: LightStateBrightness) | fun(_: LightBrightness, _: LightStateBrightness)[]?
----@field client AsyncClient?
-local ConfigLightLightStateBrightness
-
----@class LightOnOff: DeviceInterface, OnOffInterface
-local LightOnOff
-devices.LightOnOff = {}
----@param config ConfigLightLightStateOnOff
----@return LightOnOff
-function devices.LightOnOff.new(config) end
-
----@class Action
----@field action
----| "broadcast"
----@field extras table<string, string>?
----@field label string
----@field clear boolean?
-local Action
-
----@class NtfyConfig
----@field url string?
----@field topic string
-local NtfyConfig
-
----@class Notification
----@field title string
----@field message string?
----@field tags string[]?
----@field priority Priority?
----@field actions Action[]?
-local Notification
-
----@alias Priority
----| "min"
----| "low"
----| "default"
----| "high"
----| "max"
-
----@class Ntfy: DeviceInterface
-local Ntfy
-devices.Ntfy = {}
----@param config NtfyConfig
----@return Ntfy
-function devices.Ntfy.new(config) end
----@async
----@param notification Notification
-function Ntfy:send_notification(notification) end
 
 ---@class HueSwitch: DeviceInterface
 local HueSwitch
@@ -334,4 +144,194 @@ function devices.HueSwitch.new(config) end
 ---@field battery_callback fun(_: HueSwitch, _: number) | fun(_: HueSwitch, _: number)[]?
 local HueSwitchConfig
 
+---@class IkeaRemote: DeviceInterface
+local IkeaRemote
+devices.IkeaRemote = {}
+---@param config IkeaRemoteConfig
+---@return IkeaRemote
+function devices.IkeaRemote.new(config) end
+
+---@class IkeaRemoteConfig
+---@field name string
+---@field room string?
+---@field single_button boolean?
+---@field topic string
+---@field client AsyncClient
+---@field callback fun(_: IkeaRemote, _: boolean) | fun(_: IkeaRemote, _: boolean)[]?
+---@field battery_callback fun(_: IkeaRemote, _: number) | fun(_: IkeaRemote, _: number)[]?
+local IkeaRemoteConfig
+
+---@class KasaOutlet: DeviceInterface, OnOffInterface
+local KasaOutlet
+devices.KasaOutlet = {}
+---@param config KasaOutletConfig
+---@return KasaOutlet
+function devices.KasaOutlet.new(config) end
+
+---@class KasaOutletConfig
+---@field identifier string
+---@field ip string
+local KasaOutletConfig
+
+---@class LightBrightness: DeviceInterface, OnOffInterface, BrightnessInterface
+local LightBrightness
+devices.LightBrightness = {}
+---@param config ConfigLightLightStateBrightness
+---@return LightBrightness
+function devices.LightBrightness.new(config) end
+
+---@class LightColorTemperature: DeviceInterface, OnOffInterface, BrightnessInterface, ColorSettingInterface
+local LightColorTemperature
+devices.LightColorTemperature = {}
+---@param config ConfigLightLightStateColorTemperature
+---@return LightColorTemperature
+function devices.LightColorTemperature.new(config) end
+
+---@class LightOnOff: DeviceInterface, OnOffInterface
+local LightOnOff
+devices.LightOnOff = {}
+---@param config ConfigLightLightStateOnOff
+---@return LightOnOff
+function devices.LightOnOff.new(config) end
+
+---@class LightSensor: DeviceInterface
+local LightSensor
+devices.LightSensor = {}
+---@param config LightSensorConfig
+---@return LightSensor
+function devices.LightSensor.new(config) end
+
+---@class LightSensorConfig
+---@field identifier string
+---@field topic string
+---@field min integer
+---@field max integer
+---@field callback fun(_: LightSensor, _: boolean) | fun(_: LightSensor, _: boolean)[]?
+---@field client AsyncClient
+local LightSensorConfig
+
+---@class LightStateBrightness
+---@field state boolean
+---@field brightness number
+local LightStateBrightness
+
+---@class LightStateColorTemperature
+---@field state boolean
+---@field brightness number
+---@field color_temp integer
+local LightStateColorTemperature
+
+---@class LightStateOnOff
+---@field state boolean
+local LightStateOnOff
+
+---@class Notification
+---@field title string
+---@field message string?
+---@field tags string[]?
+---@field priority Priority?
+---@field actions Action[]?
+local Notification
+
+---@class Ntfy: DeviceInterface
+local Ntfy
+devices.Ntfy = {}
+---@param config NtfyConfig
+---@return Ntfy
+function devices.Ntfy.new(config) end
+---@async
+---@param notification Notification
+function Ntfy:send_notification(notification) end
+
+---@class NtfyConfig
+---@field url string?
+---@field topic string
+local NtfyConfig
+
+---@class OutletOnOff: DeviceInterface, OnOffInterface
+local OutletOnOff
+devices.OutletOnOff = {}
+---@param config ConfigOutletOutletStateOnOff
+---@return OutletOnOff
+function devices.OutletOnOff.new(config) end
+
+---@class OutletPower: DeviceInterface, OnOffInterface
+local OutletPower
+devices.OutletPower = {}
+---@param config ConfigOutletOutletStatePower
+---@return OutletPower
+function devices.OutletPower.new(config) end
+
+---@class OutletStateOnOff
+---@field state boolean
+local OutletStateOnOff
+
+---@class OutletStatePower
+---@field state boolean
+---@field power number
+local OutletStatePower
+
+---@alias OutletType
+---| "Outlet"
+---| "Kettle"
+
+---@class Presence: DeviceInterface
+local Presence
+devices.Presence = {}
+---@param config PresenceConfig
+---@return Presence
+function devices.Presence.new(config) end
+---@async
+---@return boolean
+function Presence:overall_presence() end
+
+---@class PresenceConfig
+---@field topic string
+---@field callback fun(_: Presence, _: boolean) | fun(_: Presence, _: boolean)[]?
+---@field client AsyncClient
+local PresenceConfig
+
+---@alias Priority
+---| "min"
+---| "low"
+---| "default"
+---| "high"
+---| "max"
+
+---@alias SensorType
+---| "Door"
+---| "Drawer"
+---| "Window"
+
+---@class WakeOnLAN: DeviceInterface
+local WakeOnLAN
+devices.WakeOnLAN = {}
+---@param config WolConfig
+---@return WakeOnLAN
+function devices.WakeOnLAN.new(config) end
+
+---@class Washer: DeviceInterface
+local Washer
+devices.Washer = {}
+---@param config WasherConfig
+---@return Washer
+function devices.Washer.new(config) end
+
+---@class WasherConfig
+---@field identifier string
+---@field topic string
+---@field threshold number
+---@field done_callback fun(_: Washer) | fun(_: Washer)[]?
+---@field client AsyncClient
+local WasherConfig
+
+---@class WolConfig
+---@field name string
+---@field room string?
+---@field topic string
+---@field mac_address string
+---@field broadcast_ip string?
+---@field client AsyncClient
+local WolConfig
+
 return devices