# Sanity

[![Package](https://img.shields.io/hexpm/v/sanity.svg)](https://hex.pm/packages/sanity) [![Documentation](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)](https://hexdocs.pm/sanity) ![CI](https://github.com/balexand/sanity/actions/workflows/elixir.yml/badge.svg)

A client library for the [Sanity CMS API](https://www.sanity.io/docs/http-api).

## Installation

The package can be installed by adding `sanity` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:sanity, "~> 2.0"}
  ]
end
```

## Examples

```elixir
request_opts = [project_id: "abc", dataset: "production", token: "secret"]
```

Request all published pages using [`Sanity.query/3`](https://hexdocs.pm/sanity/Sanity.html#query/3):

```elixir
Sanity.query(~S'*[_type == "page"]', %{}, perspective: "published")
|> Sanity.request!(request_opts)
```

Make the same request with [`Sanity.stream/1`](https://hexdocs.pm/sanity/Sanity.html#stream/1):

```elixir
Sanity.stream(query: ~S'_type == "page"', request_opts: request_opts)
|> Enum.to_list()
```

## Related Projects

* [`cms`](https://github.com/balexand/cms) - An experimental library for syncing content from any headless CMS to ETS tables.
* [`sanity_components`](https://github.com/balexand/sanity_components) - Phoenix components for rendering [images](https://www.sanity.io/docs/presenting-images) and [portable text](https://www.sanity.io/docs/presenting-block-text).
* [`sanity_sync`](https://github.com/balexand/sanity_sync) - For syncing content from Sanity CMS to Ecto.

## Supported endpoints

- [x] Assets
- [x] Doc
- [ ] Export
- [ ] History
- [ ] ~Listen~ (see https://github.com/balexand/sanity/pull/74)
- [x] Mutate
- [ ] Projects
- [x] Query