Builds the AshPhoenix.Form :forms keyword list from the nested entities.

Used by the generated Resource.Form.for_action/2 helper so callers never have to hand-write the nested form configuration.

@spec effective_entities(module()) :: list()

Returns all effective form entities: effective_fields/1 followed by the NestedForm structs declared in the DSL.

This is the preferred accessor for rendering — it gives a complete, ordered list of what to render without requiring explicit field declarations.

Only call this on a compiled resource module.

@spec effective_fields(module()) :: [AshFormBuilder.Field.t()]

Returns the effective list of Field structs for the form action.

Fields are produced by auto-inferring from the action's accept list, then applying explicit DSL declarations as overrides (explicit wins per field name).

Any DSL field whose name is not in the inferred list is appended at the end, allowing you to add argument fields not in accept.

Only call this on a compiled resource module, not on a dsl_state map.

@spec form(dsl_or_extended :: module() | map()) :: [struct()]

form DSL entities

@spec form_action(dsl_or_extended :: module() | map()) :: {:ok, atom()} | :error

Returns the configured :action option, or nil if no form block.

@spec form_action!(dsl_or_extended :: module() | map()) :: atom() | no_return()

The Ash action this form targets, e.g. :create or :update.

@spec form_creatable(dsl_or_extended :: module() | map()) :: {:ok, boolean()} | :error

Enable creatable combobox for all many_to_many relationships. Individual fields can override this.

@spec form_creatable!(dsl_or_extended :: module() | map()) :: boolean() | no_return()

Enable creatable combobox for all many_to_many relationships. Individual fields can override this.

@spec form_create_action(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

Default action to use for creating new items in creatable comboboxes.

@spec form_create_action!(dsl_or_extended :: module() | map()) :: atom() | no_return()

Default action to use for creating new items in creatable comboboxes.

All DSL entities in declaration order (mix of Field and NestedForm structs).

@spec form_field_order(dsl_or_extended :: module() | map()) ::
  {:ok, [atom()]} | :error

Custom ordering for fields. Fields listed first appear first. Fields not listed appear after in default order.

@spec form_field_order!(dsl_or_extended :: module() | map()) :: [atom()] | no_return()

Custom ordering for fields. Fields listed first appear first. Fields not listed appear after in default order.

Only the top-level Field structs declared in the DSL.

@spec form_form_id(dsl_or_extended :: module() | map()) :: {:ok, String.t()} | :error

HTML id attribute for the <form> element.

@spec form_form_id!(dsl_or_extended :: module() | map()) :: String.t() | no_return()

HTML id attribute for the <form> element.

Returns the configured :form_id, or nil.

@spec form_ignore_fields(dsl_or_extended :: module() | map()) ::
  {:ok, [atom()]} | :error

Fields to exclude from auto-inference. Use this to hide fields without writing full field blocks.

@spec form_ignore_fields!(dsl_or_extended :: module() | map()) ::
  [atom()] | no_return()

Fields to exclude from auto-inference. Use this to hide fields without writing full field blocks.

@spec form_include_timestamps(dsl_or_extended :: module() | map()) ::
  {:ok, boolean()} | :error

Whether to include :inserted_at and :updated_at fields. Set to true if you need timestamp inputs.

@spec form_include_timestamps!(dsl_or_extended :: module() | map()) ::
  boolean() | no_return()

Whether to include :inserted_at and :updated_at fields. Set to true if you need timestamp inputs.

@spec form_module(dsl_or_extended :: module() | map()) :: {:ok, atom()} | :error

Override the auto-generated helper module name (default: Resource.Form).

@spec form_module!(dsl_or_extended :: module() | map()) :: atom() | no_return()

Override the auto-generated helper module name (default: Resource.Form).

Returns the override :module option, or nil (generator uses Resource.Form by default).

Only the NestedForm structs declared in the DSL.

@spec form_options(dsl_or_extended :: module() | map()) :: %{
  required(atom()) => any()
}

form DSL options

Returns a map containing the and any configured or default values.

@spec form_submit_label(dsl_or_extended :: module() | map()) ::
  {:ok, String.t()} | :error

Returns the configured :submit_label, defaulting to "Submit".

@spec form_submit_label!(dsl_or_extended :: module() | map()) ::
  String.t() | no_return()

Label for the submit button.

@spec form_wrapper_class(dsl_or_extended :: module() | map()) ::
  {:ok, String.t()} | :error

Returns the configured :wrapper_class, defaulting to "space-y-4".

@spec form_wrapper_class!(dsl_or_extended :: module() | map()) ::
  String.t() | no_return()

CSS class applied to the fields wrapper <div>.

True when the resource has a form block with an action set.