refactor(widget): improve props handling, esp for templates

lua/wikis/commons/Widget.lua

@@ -19,8 +19,28 @@ local Table = Lua.import('Module:Table')
 ---@operator call(table): self
 ---@field context Widget[]
 ---@field props table<string, any>
+---@field propSpec table<string, any>
 local Widget = Class.new(function(self, props)
-	self.props = Table.deepMerge(Table.deepCopy(self.defaultProps), props)
+	---@return table<string, any>
+	local getDefaultProps = function()
+		if Table.isNotEmpty(self.defaultProps) then
+			return self.defaultProps
+		end
+		if Table.isNotEmpty(self.propSpec) then
+			return Table.mapValues(self.propSpec, function(prop)
+				return prop.default
+			end)
+		end
+		return {}
+	end
+
+	self.props = Table.deepMerge(Table.deepCopy(getDefaultProps()), props)
+
+	for propName, prop in pairs(self.propSpec) do
+		if prop.required and self.props[propName] == nil then
+			error('Missing required property: ' .. propName)
+		end
+	end
 
 	if not Array.isArray(self.props.children) then
 		self.props.children = {self.props.children}
@@ -29,7 +49,9 @@ local Widget = Class.new(function(self, props)
 	self.context = {} -- Populated by the parent
 end)
 
+---@deprecated
 Widget.defaultProps = {}
+Widget.propSpec = {}
 
 ---Asserts the existence of a value and copies it
 ---@param value string

lua/wikis/commons/Widget/Basic/Slider.lua

@@ -29,29 +29,39 @@ local Div = HtmlWidgets.Div
 ---@field props SliderWidgetParameters
 
 local Slider = Class.new(Widget)
+Slider.propSpec = {
+	id = {type = 'integer', required = true},
+	min = {type = 'integer', default = 1},
+	max = {type = 'integer', default = 100},
+	step = {type = 'integer', default = 1},
+	defaultValue = {type = 'integer', default = 1},
+	class = {type = 'string'},
+	title = {type = 'function', default = function(v) return tostring(v) end},
+	childrenAtValue = {type = 'function', required = true},
+}
+
 ---@return Widget
 function Slider:render()
-	assert(self.props.id, 'Slider requires a unique id property')
-	-- We make the real slider in js
-	local min, max, step = self.props.min or 0, self.props.max or 100, self.props.step or 1
+	local min, max, step = self.props.min, self.props.max, self.props.step
 
 	local children = {}
 	for value = min, max, step do
 		table.insert(children, {
 			content = self.props.childrenAtValue(value) or '',
-			title = self.props.title and self.props.title(value) or value,
+			title = self.props.title(value),
 			value = value,
 		})
 	end
 
+	-- We make the real slider in js
 	return Div{
 		classes = { 'slider' },
 		attributes = {
 			['data-id'] = self.props.id,
 			['data-min'] = min,
 			['data-max'] = max,
 			['data-step'] = step,
-			['data-value'] = self.props.defaultValue or self.props.min or 0,
+			['data-value'] = self.props.defaultValue,
 		},
 		children = Array.map(children, function(child)
 			return HtmlWidgets.Div{

lua/wikis/commons/Widget/Factory.lua

@@ -8,17 +8,78 @@
 local Lua = require('Module:Lua')
 
 local Class = Lua.import('Module:Class')
+local Json = Lua.import('Module:Json')
+local Logic = Lua.import('Module:Logic')
 
 local WidgetFactory = {}
 
----@param args {widget: string, children: ((Widget|Html|string|number)[])|Widget|Html|string|number, [any]:any}
+---@param args {widget: string, children: any, [any]:any}
 ---@return Widget
 function WidgetFactory.fromTemplate(args)
 	local widgetClass = args.widget
 	args.widget = nil
-	args.children = type(args.children) == 'table' and args.children or {args.children}
-	local WidgetClass = Lua.import('Module:Widget/' .. widgetClass)
+
+	local WidgetClass = Lua.requireIfExists('Module:Widget/' .. widgetClass)
+	assert(WidgetClass, 'Widget not found: ' .. widgetClass)
+	---@cast WidgetClass Widget
+
+	local propSpec = WidgetClass.propSpec
+	args.children = WidgetFactory._parseTable(args.children) or args.children
+
+	for propName, prop in pairs(propSpec) do
+		if prop.type == 'integer' then
+			args[propName] = WidgetFactory._parseInteger(args[propName])
+		elseif prop.type == 'string' then
+			args[propName] = WidgetFactory._parseString(args[propName])
+		elseif prop.type == 'table' then
+			args[propName] = WidgetFactory._parseTable(args[propName])
+		elseif prop.type == 'boolean' then
+			args[propName] = WidgetFactory._parseBoolean(args[propName])
+		end
+	end
+
 	return WidgetClass(args)
 end
 
+---@param integer any
+---@return integer|nil
+function WidgetFactory._parseInteger(integer)
+	if type(integer) == 'number' then
+		return integer
+	end
+	return tonumber(integer)
+end
+
+---@param string any
+---@return string|nil
+function WidgetFactory._parseString(string)
+	if type(string) == 'string' then
+		return string
+	end
+	return tostring(string)
+end
+
+---@param table any
+---@return table|nil
+function WidgetFactory._parseTable(table)
+	if type(table) == 'table' then
+		return table
+	elseif type(table) == 'string' then
+		local parsedTable, parsingError = Json.parseStringified(table)
+		if not parsingError then
+			return parsedTable
+		end
+	end
+	return nil
+end
+
+---@param boolean any
+---@return boolean|nil
+function WidgetFactory._parseBoolean(boolean)
+	if type(boolean) == 'boolean' then
+		return boolean
+	end
+	return Logic.readBool(boolean)
+end
+
 return Class.export(WidgetFactory, {exports = {'fromTemplate'}})