MishkaGervaz.Form.Web.UploadHelpers (MishkaGervaz v0.0.1-alpha.2)

Shared utility functions for file upload wiring in MishkaGervaz forms.

Provides helpers to:

Build allow_upload/3 options from DSL config
Generate namespaced upload names to avoid collisions
Parse accept strings
Check if a form config has uploads

See MishkaGervaz.Form.Web.Live (calls build_allow_upload_opts/2 + namespaced_upload_name/2 at mount), MishkaGervaz.Form.Web.Events.UploadHandler (uses namespaced_upload_name/2 for consume_uploaded_entries), MishkaGervaz.Form.Templates.Standard (uses find_upload_for_field/2 + upload_error_to_string/1), and MishkaGervaz.Form.Entities.Upload.

Summary

Functions

build_allow_upload_opts(upload_config, component_id)

Build keyword options for Phoenix.LiveView.allow_upload/3 from a DSL upload config map.

find_upload_for_field(arg1, field_name)

Find the upload config for a given field name.

has_uploads?(arg1)

Check if a Static config struct has any uploads configured.

namespaced_upload_name(upload_name, component_id)

Generate a namespaced upload name unique per component instance.

parse_accept(accept)

Parse an accept string into a list of MIME types / extensions.

upload_error_to_string(error)

Convert an upload error atom to a human-readable string.

Functions

build_allow_upload_opts(upload_config, component_id)

@spec build_allow_upload_opts(map(), String.t()) :: keyword()

Build keyword options for Phoenix.LiveView.allow_upload/3 from a DSL upload config map.

Examples

iex> build_allow_upload_opts(%{accept: "image/*", max_entries: 3, max_file_size: 10_000_000, auto_upload: true}, "my-form")
[accept: ~w(image/*), max_entries: 3, max_file_size: 10_000_000, auto_upload: true]

find_upload_for_field(arg1, field_name)

@spec find_upload_for_field(map(), atom()) :: map() | nil

Find the upload config for a given field name.

Matches by field first, then by name.

has_uploads?(arg1)

@spec has_uploads?(map()) :: boolean()

Check if a Static config struct has any uploads configured.

namespaced_upload_name(upload_name, component_id)

@spec namespaced_upload_name(atom(), String.t()) :: atom()

Generate a namespaced upload name unique per component instance.

This avoids collisions when multiple form components are on the same page.

Examples

iex> namespaced_upload_name(:avatar, "post-form")
:avatar_post_form

parse_accept(accept)

@spec parse_accept(String.t() | [String.t()] | nil) :: :any | [String.t()]

Parse an accept string into a list of MIME types / extensions.

Returns :any if nil, or a list of trimmed parts.

Examples

iex> parse_accept(nil)
:any

iex> parse_accept("image/*,.pdf")
["image/*", ".pdf"]

upload_error_to_string(error)

@spec upload_error_to_string(atom()) :: String.t()

Convert an upload error atom to a human-readable string.