@spec change_page(Beacon.Content.Page.t(), map()) :: Ecto.Changeset.t()

Returns an %Ecto.Changeset{} for tracking page changes.

Example

iex> change_page(page, %{title: "My Campaign"})
%Ecto.Changeset{data: %Page{}}

@spec count_pages(
  Beacon.Types.Site.t(),
  keyword()
) :: integer()

Counts the total number of pages based on the amount of pages.

Options

• :query - filter rows count by query

@spec create_page(map()) ::
  {:ok, Beacon.Content.Page.t()} | {:error, Ecto.Changeset.t()}

Creates a new page that's not published.

Example

iex> create_page(%{"title" => "My New Page"})
{:ok, %Page{}}

attrs may contain the following keys:

• path - String.t()
• title - String.t()
• description - String.t()
• template - String.t()
• meta_tags - list(map()) eg: [%{"property" => "og:title", "content" => "My New Site"}]

See Beacon.Content.Page for more info.

The created page is not published automatically, you can make as much changes you need and when the page is ready to be published you can call publish_page/1

It will insert a created event into the page timeline, and no snapshot is created.

@spec create_page!(map()) :: Beacon.Content.Page.t()

Creates a page.

Raises an error if unsuccessful.

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

Returns the list of meta tags that are applied to all pages by default.

These meta tags can be overwritten or extended on a Layout or Page level.

@spec get_latest_page_event(Beacon.Types.Site.t(), Ecto.UUID.t()) ::
  Beacon.Content.PageEvent.t() | nil

Returns the latest page event.

Useful to find the status of a page.

Example

iex> get_latest_page_event(:my_site, page_id)
%PageEvent{event: :published}

@spec get_page(Beacon.Types.Site.t(), Ecto.UUID.t(), keyword()) ::
  Beacon.Content.Page.t() | nil

Gets a single page by id.

Options

• :preloads - a list of preloads to load.

Examples

iex> get_page(:my_site, "dba8a99e-311a-4806-af04-dd968c7e5dae")
%Page{}

iex> get_page(:my_site, "dba8a99e-311a-4806-af04-dd968c7e5dae", preloads: [:layout])
%Page{layout: %Layout{}}

@spec get_page!(Beacon.Types.Site.t(), Ecto.UUID.t(), keyword()) ::
  Beacon.Content.Page.t()

Same as get_page/3 but raises an error if no result is found.

@spec get_page_by(Beacon.Types.Site.t(), keyword(), keyword()) ::
  Beacon.Content.Page.t() | nil

Gets a single page by clauses.

Example

iex> get_page_by(site, path: "/contact")
%Page{}

@spec get_published_page(Beacon.Types.Site.t(), Ecto.UUID.t()) ::
  Beacon.Content.Page.t() | nil

Get latest published page.

This operation is cached.

@spec list_page_events(Beacon.Types.Site.t(), Ecto.UUID.t()) :: [
  Beacon.Content.PageEvent.t()
]

Returns all page events with associated snapshot if available.

Example

iex> list_page_events(:my_site, page_id)
[
  %PageEvent{event: :created, snapshot: nil},
  %PageEvent{event: :published, snapshot: %PageSnapshot{}}
]

@spec list_pages(
  Beacon.Types.Site.t(),
  keyword()
) :: [Beacon.Content.Page.t()]

List pages.

Options

• :per_page - limit how many records are returned, or pass :infinity to return all records. Defaults to 20.
• :page - returns records from a specfic page. Defaults to 1.
• :query - search pages by path or title.
• :preloads - a list of preloads to load.
• :sort - column in which the result will be ordered by. Defaults to :path. Allowed values: :path, :title, :description, :template, :meta_tags, :raw_schema, :format, :inserted_at, :updated_at.

@spec list_published_pages(
  Beacon.Types.Site.t(),
  keyword()
) :: [Beacon.Content.Page.t()]

Lists and search all published pages for site.

Note that unpublished pages are not returned even if it was once published before, only the latest snapshot is considered.

Options

• :per_page - limit how many records are returned, or pass :infinity to return all records. Defaults to 20.
• :page - returns records from a specfic page. Defaults to 1.
• :search - search by either one or more fields or dynamic query function.

          Available fields: `path`, `title`, `format`, `extra`. Defaults to `nil` (do not apply search filter).

• :sort - column in which the result will be ordered by. Defaults to :title.

Examples

iex> list_published_pages(:my_site, search: %{path: "/home", title: "Home Page"})
[%Page{}]

iex> list_published_pages(:my_site, search: %{extra: %{"tags" => "press"}})
[%Page{}]

iex> list_published_pages(:my_site, search: fn -> dynamic([q], fragment("extra->>'tags' ilike 'year-20%'")) end)
[%Page{}]

@spec list_published_pages_for_paths(Beacon.Types.Site.t(), [String.t()]) :: [
  Beacon.Content.Page.t()
]

Similar to list_published_pages/2, but does not accept any options. Instead, provide a list of paths, and this function will return any published pages which match one of those paths.

@spec publish_page(Beacon.Content.Page.t()) ::
  {:ok, Beacon.Content.Page.t()} | {:error, Ecto.Changeset.t() | term()}

Publish page.

A new snapshot is automatically created to store the page data, which is used whenever the site or the page is reloaded. So you can keep editing the page as needed without impacting the published page.

This operation is serialized.

@spec publish_page(Beacon.Types.Site.t(), Ecto.UUID.t()) ::
  {:ok, Beacon.Content.Page.t()} | {:error, Ecto.Changeset.t()}

Same as publish_page/1 but accepts a site and page_id with which to lookup the page.

@spec publish_pages([Beacon.Content.Page.t()]) :: {:ok, [Beacon.Content.Page.t()]}

Publish multiple pages.

Similar to publish_page/1 but defers loading dependent resources as late as possible making the process faster.

@spec put_page_extra(Beacon.Content.Page.t(), map()) ::
  {:ok, Beacon.Content.Page.t()} | {:error, Ecto.Changeset.t()}

Given a map of fields, stores this map as :extra fields in a Page.

Any existing :extra data for that Page will be overwritten!

@spec unpublish_page(Beacon.Content.Page.t()) ::
  {:ok, Beacon.Content.Page.t()} | {:error, Ecto.Changeset.t()}

Unpublish page.

Note that page will be removed from your site and it will return error 404 for new requests.

@spec update_page(Beacon.Content.Page.t(), map()) ::
  {:ok, Beacon.Content.Page.t()} | {:error, Ecto.Changeset.t()}

Updates a page.

Example

iex> update_page(page, %{title: "New Home"})
{:ok, %Page{}}

@spec validate_page(Beacon.Types.Site.t(), Beacon.Content.Page.t(), map()) ::
  Ecto.Changeset.t()

Validate page with the given params.

All Beacon.Content.PageField are validated