@spec config_for_media_type(t(), String.t()) :: media_type_config()

From a Beacon.Config, fetch the asset config for a given media type, raising when unsuccessful.

Example

iex> beacon_config = Beacon.Config.fetch!(:some_site)
iex> jpeg_config = config_for_media_type(beacon_config, "image/jpeg")

@spec fetch!(Beacon.Types.Site.t()) :: t()

Returns the Beacon.Config for site.

@spec get_media_type_config(media_type_configs(), String.t()) ::
  media_type_config() | nil

@spec get_media_type_config(extra_asset_fields(), String.t()) ::
  extra_asset_field() | nil

Searches a config option for the given media type.

For config options based on media type, such as :assets and :extra_asset_fields, this function will check for the presence of media_type, returning the config for that specific type, or nil if the type is not present.

Examples

iex> beacon_config = Beacon.Config.fetch!(:some_site)
iex> jpeg_config = config_for_media_type(beacon_config.assets, "image/jpeg")

iex> beacon_config = Beacon.Config.fetch!(:some_site)
iex> webp_config = config_for_media_type(beacon_config.extra_asset_fields, "image/webp")

iex> beacon_config = Beacon.Config.fetch!(:some_site)
iex> nil = config_for_media_type(beacon_config.assets, "invalid/foo")

@spec new([option()]) :: t()

Build a new %Beacon.Config{} instance to hold the entire configuration for each site.

Options

• :site - Beacon.Types.Site.t/0 (required)

• :endpoint - endpoint/0 (required)

• :router - router/0 (required)

• :repo - repo/0 (required)

• :mode - mode/0 (optional). Defaults to :live.

• css_compiler - css_compiler/0 (optional). Defaults to Beacon.RuntimeCSS.TailwindCompiler.

• :tailwind_config - tailwind_config/0 (optional). Defaults to Path.join(Application.app_dir(:beacon, "priv"), "tailwind.config.bundle.js").

• :tailwind_css - tailwind_css/0 (optional). Defaults to Path.join(Application.app_dir(:beacon, "priv"), "tailwind.css").

• :live_socket_path - live_socket_path/0 (optional). Defaults to "/live".

• :safe_code_check - safe_code_check/0 (optional). Defaults to false.

• :template_formats - template_formats/0 (optional).

  Defaults to:

      [
        {:heex, "HEEx (HTML)"},
        {:markdown, "Markdown (GitHub Flavored version)"}
      ]

Note that the default config is merged with your config.

• lifecycle - lifecycle/0 (optional).

Note that the default config is merged with your config.

• :extra_page_fields - extra_page_fields/0 (optional). Defaults to [].

• :extra_asset_fields - extra_asset_fields/0 (optional). Defaults to [].

• :default_meta_tags - default_meta_tags/0 (optional). Defaults to %{}.

Example

iex> Beacon.Config.new(
  site: :my_site,
  endpoint: MyAppWeb.Endpoint,
  router: MyAppWeb.Router,
  repo: MyApp.Repo,
  tailwind_config: Path.join(Application.app_dir(:my_app, "priv"), "tailwind.config.js"),
  tailwind_css: Path.join([Application.app_dir(:my_app, "assets"), "css", "app.css"]),
  template_formats: [
    {:custom_format, "My Custom Format"}
  ],
  lifecycle: [
    load_template: [
      {:custom_format,
       [
         validate: fn template, _metadata -> MyEngine.validate(template) end
       ]}
    ],
    render_template: [
      {:custom_format,
       [
         assigns: fn %Phoenix.LiveView.Rendered{static: template} , %{assigns: assigns} -> MyEngine.parse_to_html(template, assigns) end
       ]}
    ],
    after_publish_page: [
      notify_admin: fn page -> {:cont, MyApp.Admin.send_email(page)} end
    ]
  ]
)
%Beacon.Config{
  site: :my_site,
  endpoint: MyAppWeb.Endpoint,
  router: MyAppWeb.Router,
  repo: MyApp.Repo,
  mode: :live,
  css_compiler: Beacon.RuntimeCSS.TailwindCompiler,
  tailwind_config: "/my_app/priv/tailwind.config.js",
  tailwind_css: "/my_app/assets/css/app.css",
  live_socket_path: "/live",
  safe_code_check: false,
  template_formats: [
    heex: "HEEx (HTML)",
    markdown: "Markdown (GitHub Flavored version)",
    custom_format: "My Custom Format"
  ],
  media_types: ["image/jpeg", "image/gif", "image/png", "image/webp"],
  assets:[
    {"image/*", [providers: [Beacon.MediaLibrary.Provider.Repo], validations: [&SomeModule.some_function/2]]},
  ],
  lifecycle: [
    load_template: [
      heex: [],
      markdown: [
        convert_to_html: &Beacon.Template.Markdown.convert_to_html/2,
      ],
      custom_format: [
        validate: #Function<41.3316493/2 in :erl_eval.expr/6>
      ]
    ],
    render_template: [
      heex: [],
      markdown: [],
      custom_format: [
        assigns: #Function<41.3316493/2 in :erl_eval.expr/6>
      ]
    ],
    after_create_page: [],
    after_update_page: [],
    after_publish_page: [
      notify_admin: #Function<42.3316493/1 in :erl_eval.expr/6>
    ],
    upload_asset: [],
  ],
  extra_page_fields: [],
  extra_asset_fields: [],
  default_meta_tags: []
}

@spec update_value(Beacon.Types.Site.t(), atom(), any()) :: t() | :error

Updates key with value for the site configuration, at runtime.