@spec all_required_pages_published?() :: boolean()

Check if all required legal pages are published.

@spec available_frameworks() :: %{
  required(String.t()) => PhoenixKit.Modules.Legal.LegalFramework.t()
}

Get available compliance frameworks.

@spec available_page_types() :: %{
  required(String.t()) => PhoenixKit.Modules.Legal.PageType.t()
}

Get available page types.

@spec consent_widget_enabled?() :: boolean()

Check if consent widget is enabled (Phase 2 feature).

@spec disable_consent_widget() :: {:ok, term()} | {:error, term()}

Disable consent widget.

@spec disable_google_consent_mode() :: {:ok, term()} | {:error, term()}

Disable Google Consent Mode v2.

@spec disable_system() :: {:ok, term()} | {:error, term()}

Disable the Legal module.

@spec enable_consent_widget() :: {:ok, term()} | {:error, term()}

Enable consent widget.

@spec enable_google_consent_mode() :: {:ok, term()} | {:error, term()}

Enable Google Consent Mode v2.

@spec enable_system() :: {:ok, :enabled} | {:error, :publishing_required | term()}

Enable the Legal module.

Requires Publishing module to be enabled first. Creates the "legal" publishing group if it doesn't exist.

Returns

• {:ok, :enabled} - Successfully enabled
• {:error, :publishing_required} - Publishing module must be enabled first

@spec enabled?() :: boolean()

Check if Legal module is enabled.

@spec generate_all_pages(keyword()) :: {:ok, map()}

Generate all required pages for selected frameworks.

Parameters

• opts: Keyword options
  • :language - Language code (default: "en")
  • :scope - User scope for audit trail
  • :include_optional - Include optional pages (default: false)

Returns

• {:ok, results} - Map of page_type => result

@spec generate_page(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Generate a legal page from template.

Parameters

• page_type: Page type slug (e.g., "privacy-policy")
• opts: Keyword options
  • :language - Language code (default: "en")
  • :scope - User scope for audit trail

Returns

• {:ok, post} on success
• {:error, reason} on failure

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

Get all pages (required + optional) for given frameworks.

@spec get_auto_policy_version() :: String.t()

Get auto-calculated policy version based on legal page updates.

Uses the latest updated_at from cookie-policy or privacy-policy pages. Falls back to manual version if no pages exist.

@spec get_company_info() :: map()

Get company information.

Reads from consolidated company_info key with fallback to legacy legal_company_info.

@spec get_config() :: map()

Get the full configuration of the Legal module.

Returns a map with:

• enabled: boolean
• frameworks: list of selected framework IDs
• company_info: map with company details
• dpo_contact: map with DPO contact info
• generated_pages: list of generated page slugs
• consent_widget_enabled: boolean (Phase 2)

@spec get_consent_mode() :: String.t()

Get consent mode.

Modes:

• "strict" - Full compliance: icon, script blocking, re-consent on policy change
• "notice" - Simple notice: banner once, no blocking, no icon

Default: "strict" for opt-in frameworks, "notice" otherwise.

@spec get_consent_widget_config() :: map()

Get full consent widget configuration for the component.

Returns a map with all settings needed by the cookie_consent component:

• enabled: boolean

• consent_mode: "strict" | "notice"

• show_icon: boolean
• icon_position: string
• policy_version: string
• google_consent_mode: boolean
• hide_for_authenticated: boolean
• frameworks: list of framework IDs
• cookie_policy_url: string
• privacy_policy_url: string

@spec get_cookie_banner_position() :: String.t()

Get cookie banner/icon position. Options: "bottom-left", "bottom-right", "top-left", "top-right"

@spec get_dpo_contact() :: map()

Get Data Protection Officer contact.

@spec get_icon_position() :: String.t()

Alias for get_cookie_banner_position/0.

@spec get_policy_version() :: String.t()

Get policy version for consent tracking. Changing this version will prompt users to re-consent.

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

Get pages required for given frameworks.

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

Get selected compliance frameworks.

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

Check if there are unpublished legal pages that are required.

Returns a list of unpublished page slugs (e.g., ["cookie-policy", "privacy-policy"]).

@spec google_consent_mode_enabled?() :: boolean()

Check if Google Consent Mode v2 is enabled.

@spec has_opt_in_framework?() :: boolean()

Check if any opt-in framework is selected.

@spec hide_for_authenticated?() :: boolean()

Check if consent widget should be hidden for authenticated users. Only applies in "notice" mode.

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

List generated legal pages.

@spec publish_page(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Publish a legal page by slug.

Parameters

• page_slug: The slug of the page to publish (e.g., "cookie-policy")
• opts: Keyword options
  • :scope - User scope for audit trail

Returns

• {:ok, post} on success
• {:error, reason} on failure

@spec set_frameworks([String.t()]) :: {:ok, term()} | {:error, term()}

Set compliance frameworks.

Parameters

• framework_ids: List of framework IDs to enable

Returns

• {:ok, setting} on success
• {:error, reason} on failure

@spec should_show_consent_icon?() :: boolean()

Check if consent icon should be shown.

Returns true only if:

• Legal module is enabled
• Consent widget is enabled
• Consent mode is "strict"
• At least one opt-in framework is selected (GDPR, UK GDPR, LGPD, PIPEDA)

@spec update_company_info(map()) :: {:ok, term()} | {:error, term()}

Update company information.

@spec update_consent_mode(String.t()) :: {:ok, term()} | {:error, term()}

Update consent mode.

@spec update_dpo_contact(map()) :: {:ok, term()} | {:error, term()}

Update DPO contact information.

@spec update_hide_for_authenticated(boolean()) :: {:ok, term()} | {:error, term()}

Update hide for authenticated setting.

@spec update_icon_position(String.t()) :: {:ok, term()} | {:error, term()}

Update cookie banner/icon position.

@spec update_policy_version(String.t()) :: {:ok, term()} | {:error, term()}

Update policy version.