Form identity and source DSL

Names the form. MishkaGervaz.Resource.Info.Form.component_id/1 returns the name. The page that mounts the form chooses the component id. It sits at mishka_gervaz.form.identity.

Option	Type	Default	Description
name	atom	none	Required. Unique form identifier.
route	String.t	none	Base route for redirects after save. Gervaz stores it. The built-in form does not redirect with it.
stream_name	atom	none	Phoenix stream name. Defaults to the name plus _stream.

Sets the actor, the master check and a gate on the whole form. Its entities set the actions, the preloads and the access rules. It sits at mishka_gervaz.form.source.

Option	Type	Default	Description
actor_key	atom	:current_user	Assigns key for current user. Stored in the config. The components take the actor from their current_user assign, and no built-in code reads this key.
master_check	(any -> any)	none	Function returning true for master users. fn user -> boolean Stored in the config. The built-in access modules do not call it: they treat a user whose site_id is nil as a master. To change the rule, override master_user?/1 in a custom access module.
restricted	boolean | (any -> any)	false	Restricts every mode of the form to master users. A function gets the state.

actions

Maps the form to Ash actions. A form with any field needs all three, on the resource or the domain. It sits at mishka_gervaz.form.source.actions.

Option	Type	Default	Description
create	atom | {atom, atom}	none	The create action. An atom serves master and tenant users alike. A tuple {master_action, tenant_action} gives each its own. Required on the resource or on the domain.
update	atom | {atom, atom}	none	The update action, in the same two forms. Required on the resource or on the domain.
read	atom | {atom, atom}	none	The read action that fetches the record in edit mode, in the same two forms. Required on the resource or on the domain.

preload

Relationships the form loads, in three tiers. It sits at mishka_gervaz.form.source.preload.

Option	Type	Default	Description
always	list(atom | {atom, atom})	[]	Relationships to preload in every mode, as atoms or {source, alias} tuples. The read action of a preloaded relationship must not set pagination required?: true, because preloads pass no limit. Use required?: false.
master	list(atom | {atom, atom})	[]	Extra preloads for master users, in the same two forms.
tenant	list(atom | {atom, atom})	[]	Extra preloads for tenant users, in the same two forms.

access

Gates whether a mode is reachable. A denied mode leaves the form without fields. It sits at mishka_gervaz.form.source.access.

Call: access mode \\ nil, condition \\ nil

Arguments:

Argument	Type	Default	Description
mode	:create | :update | (any, any -> any)	none	The mode this rule gates, :create or :update. A function fn mode, state -> boolean in this place is a global gate for both modes.
condition	boolean | (any -> any) | (any, any -> any)	none	The rule for the mode: a boolean or fn state -> boolean. false closes the mode for everyone. A function of two arguments in this place is not evaluated, and the mode stays open.

Options:

Option	Type	Default	Description
restricted	boolean	false	Restrict this mode to master users.

The four calling styles:

Call	Meaning
access :create, restricted: true	Only master users reach the mode.
access :update, fn state -> state.master_user? end	A rule for one mode.
access fn mode, state -> mode == :update end	One rule for both modes.
access :update, false	Closes the mode for everyone. Its actions need not exist.

• Build an admin form: a guide that uses these sections.
• Master and tenant users: why actions come as tuples.
• Troubleshooting: the compile messages for forms.