Athanor.Ctx (Athanor v0.1.0-beta.1)

Copy Markdown View Source

Context struct carried through every Athanor.Renderer dispatch.

Holds two kinds of data:

  • Passthrough: user_id, account_id, api_token, brand_id, cart_id. Athanor does not interpret these — they exist so consumer apps can give their components the bits of session context they need (auth, scoping, current cart).

  • Adapters: asset_picker, rich_text, data_sources, i18n. These are pluggable behaviours that components consume instead of importing app-specific modules. v1 keeps the fields with nil defaults; adapter behaviours land in a later step.

  • Editor mode: edit_mode?, add_component_callback, and select_component_callback. Set by the host LiveView when rendering inside the editor canvas. Container components (e.g. Athanor.Components.Columns) branch on edit_mode? to render canvas chrome, invoke add_component_callback.(zone_name) so the consumer can open its palette modal pre-targeted at the right zone, and invoke select_component_callback.(node_id) to render a "Configure" button per nested child that opens the consumer's config panel.

extra is a free-form map for consumer-side passthrough that doesn't fit the named fields (feature flags, request id, A/B test bucket, etc.). Athanor never inspects extra.

Examples

iex> ctx = Athanor.Ctx.new(account_id: "a1", cart_id: "c1")
iex> ctx.account_id
"a1"

iex> Athanor.Ctx.new().data_sources
%{}

Summary

Types

t()

Functions

new()

Build an empty Ctx with all default values.

new(overrides)

Build a Ctx with overrides supplied as a keyword list or map.

Types

t()

@type t() :: %Athanor.Ctx{
  account_id: String.t() | nil,
  add_component_callback: (String.t() -> any()) | nil,
  api_token: String.t() | nil,
  asset_picker: module() | nil,
  brand_id: String.t() | nil,
  cart_id: String.t() | nil,
  data_sources: %{required(String.t()) => module()},
  edit_mode?: boolean(),
  extra: map(),
  i18n: module() | nil,
  rich_text: module() | nil,
  select_component_callback: (String.t() -> any()) | nil,
  user_id: String.t() | nil
}

Functions

new()

Build an empty Ctx with all default values.

new(overrides)

Build a Ctx with overrides supplied as a keyword list or map.

Unknown keys raise KeyError to catch typos early.