<p align="center">
  <img width="400" height="62" src="https://raw.githubusercontent.com/nutshell-lab/meilisearch-ex/main/meilisearch-ex.png">
</p>

An **unofficial** [Meilisearch](https://www.meilisearch.com/) client based on [Finch](https://github.com/sneako/finch) HTTP client wrapped by [Tesla](https://github.com/elixir-tesla/tesla).

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/nutshell-lab/meilisearch-ex/elixir.yml)](https://github.com/nutshell-lab/meilisearch-ex/actions/workflows/elixir.yml)
[![GitHub](https://img.shields.io/github/license/nutshell-lab/meilisearch-ex)](https://github.com/nutshell-lab/meilisearch-ex/blob/main/LICENCE)
[![Hex.pm](https://img.shields.io/hexpm/v/meilisearch_ex)](https://hex.pm/packages/meilisearch_ex)
[![Hex.pm](https://img.shields.io/hexpm/dw/meilisearch_ex)](https://hex.pm/packages/meilisearch_ex)
[![Hexdocs.pm](https://img.shields.io/badge/hexdocs-documentation-ff69b4)](https://hexdocs.pm/meilisearch_ex)
[![Coveralls](https://img.shields.io/coverallsCoverage/github/nutshell-lab/meilisearch-ex)](https://coveralls.io/github/nutshell-lab/meilisearch-ex)

## Installation

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

```elixir
def deps do
  [
    {:finch, "~> 0.14.0"},
    {:meilisearch_ex, "~> 1.1.0"}
  ]
end
```

Documentation can be found at <https://hexdocs.pm/meilisearch_ex>.

## Usage

You can create a client when you needs it.

```elixir
# Start finch with your app
Finch.start_link(name: :search_finch)

# Create a Meilisearch client whenever and wherever you need it.
[endpoint: "https://search.mydomain.com", key: "replace_me", finch: :search_finch]
|> Meilisearch.Client.new()
|> Meilisearch.Health.get()

# %Meilisearch.Health{status: "available"}
```

But you can also start a client alongside your application to access it whenever you need it.

```elixir
Finch.start_link(name: :search_finch)
Meilisearch.start_link(:main, [
  endpoint: "https://search.mydomain.com",
  key: "replace_me",
  finch: :search_finch
])

:main
|> Meilisearch.client()
|> Meilisearch.Health.get()

# %Meilisearch.Health{status: "available"}
```

Within a Phoenix app you would do like this:

```elixir
defmodule MyApp.Application do
  # ...

  @impl true
  def start(_type, _args) do
    children = [
      # ...
      {Finch, name: :search_finch},
      {Meilisearch, name: :search_admin, endpoint: "https://search.mydomain.com", key: "key_admin", finch: :search_finch},
      {Meilisearch, name: :search_public, endpoint: "https://search.mydomain.com", key: "key_public", finch: :search_finch}
    ]

    # ...
  end

  # ...
end

defmodule MyApp.MyContext do
  def create_search_index() do
    :search_admin
    |> Meilisearch.client()
    |> Meilisearch.Index.create(%{uid: "items", primaryKey: "id"})
  end

  def add_documents_to_search_index(documents) do
    :search_admin
    |> Meilisearch.client()
    |> Meilisearch.Document.create_or_replace("items", documents)
  end

  def search_document(query) do
    :search_public
    |> Meilisearch.client()
    |> Meilisearch.Search.search("items", %{q: query})
  end
end
```

## Compatibility

For now, we only support version `1.0.x` of Meilisearch.

|  meilisearch  | meilisearch-ex |
| ------------- | ------------- |
|     1.0.x     |      1.0      |
|     1.1.x     |      1.1      |