view teal-src/util/dataforms.d.tl @ 12956:52fcdfe710ca

storagemanager: Add keyval+ (combined keyval + map) store type This combines the two most common store types, which modules often end up opening with both interfaces separately anyway. As well as combining them, I've taken the opportunity to improve some of the method names to make them clearer.
author Matthew Wild <mwild1@gmail.com>
date Tue, 27 Sep 2022 17:46:27 +0100
parents b2047b82ec85
children
line wrap: on
line source

local stanza_t = require "util.stanza".stanza_t

local record lib
	record dataform
		title : string
		instructions : string

		record form_field

			enum field_type
				"boolean"
				"fixed"
				"hidden"
				"jid-multi"
				"jid-single"
				"list-multi"
				"list-single"
				"text-multi"
				"text-private"
				"text-single"
			end

			type : field_type
			var : string -- protocol name
			name :  string -- internal name

			label : string
			desc : string

			datatype : string
			range_min : number
			range_max : number

			value : any -- depends on field_type
			options : table
		end

		{ form_field }

		enum form_type
			"form"
			"submit"
			"cancel"
			"result"
		end

		form : function ( dataform, { string : any }, form_type ) : stanza_t
		data : function ( dataform, stanza_t ) : { string : any }
	end

	new : function ( dataform ) : dataform
end

return lib