@spec all_admin_tabs() :: [PhoenixKit.Dashboard.Tab.t()]

Collect all admin tabs from all registered modules.

Note: iterates all modules and calls admin_tabs/0 on each call. For cached access in rendering paths, use PhoenixKit.Dashboard.Registry.get_admin_tabs/0.

@spec all_children() :: [Supervisor.child_spec()]

Collect all supervisor child specs from all registered modules.

@spec all_feature_keys() :: [String.t()]

Returns all feature module key strings from registered modules.

@spec all_modules() :: [module()]

Returns all registered module atoms.

@spec all_permission_metadata() :: [PhoenixKit.Module.permission_meta()]

Collect permission metadata from all registered modules.

@spec all_route_modules() :: [module()]

Collect route modules from all registered modules.

@spec all_settings_tabs() :: [PhoenixKit.Dashboard.Tab.t()]

Collect all settings tabs from all registered modules.

@spec all_user_dashboard_tabs() :: [PhoenixKit.Dashboard.Tab.t()]

Collect all user dashboard tabs from all registered modules.

Returns a specification to start this module under a supervisor.

See Supervisor.

@spec dependency_warnings() :: [map()]

Returns dependency warnings for the Modules page.

Each warning is a map: %{module: module(), module_name: String.t(), requires_key: String.t()}

Called on Modules page render — computes live (not hot path).

@spec enabled_modules() :: [module()]

Returns all registered modules that are currently enabled.

@spec feature_enabled_checks() :: %{required(String.t()) => {module(), atom()}}

Build a feature_enabled_checks map from registered modules.

Returns %{"referrals" => {PhoenixKit.Modules.Referrals, :enabled?}, ...}

@spec get_by_key(String.t()) :: module() | nil

Find a registered module by its key string.

@spec initialized?() :: boolean()

Check if the registry has been initialized.

@spec modules_with_migrations() :: [{String.t(), module()}]

Collect modules that have versioned migrations.

Returns a list of {module_name, migration_module} tuples for all registered modules that implement migration_module/0 and return a non-nil value.

@spec not_installed_packages() :: [map()]

Returns known external PhoenixKit packages that are not currently installed.

Used by the admin Modules page to inform users about available packages they can add as dependencies.

@spec permission_descriptions() :: %{required(String.t()) => String.t()}

Returns permission descriptions map from registered modules.

@spec permission_icons() :: %{required(String.t()) => String.t()}

Returns permission icons map from registered modules.

@spec permission_labels() :: %{required(String.t()) => String.t()}

Returns permission labels map from registered modules.

@spec register(module()) :: :ok

Register a module that implements PhoenixKit.Module behaviour.

@spec run_all_legacy_migrations() :: %{required(module()) => :ok | {:error, term()}}

Run every enabled module's migrate_legacy/0 callback.

Iterates registered modules, calls migrate_legacy/0 on each that implements it, swallows per-module errors so the host-app boot can't be taken down by a flaky migration. Each module's implementation is expected to be idempotent (safe to re-run on every boot).

Activity logging happens inside each module's migrate_legacy/0 — this orchestrator only logs the per-module pass/fail outcome to the Logger, not to Activity.

Designed to be called once from a host app's Application.start/2 after the Repo and supervision tree are up:

def start(_type, _args) do
  children = [...]
  result = Supervisor.start_link(children, opts)
  PhoenixKit.ModuleRegistry.run_all_legacy_migrations()
  result
end

Returns a summary map: %{module_atom => :ok | {:error, term()}}.

@spec static_children() :: [Supervisor.child_spec()]

Collect supervisor child specs from the static module list.

This does NOT require the GenServer to be running, making it safe to call from the PhoenixKit.Supervisor init (before the registry starts).

@spec unregister(module()) :: :ok

Unregister a module.