@spec coerce_to_elixir_type(String.t()) :: atom()

Coerces a CouchDB "type" field to an existing atom. It is assumed that there will be a related Elixir Module Type of the same name. Elixir prefixes Module names with Elixir. and then elides this in iex, tests, and elsewhere, but here we need to make that explicit.

The "user" type is special-cased as it is already present in CouchDB /_users database.

This function is expected to be paired up with Ecto Schemas to properly manage the appropriate fields in your document body.

@spec delete(Sofa.t(), t()) :: {:error, any()} | {:ok, Sofa.t(), any()}

delete doc

@spec exists(Sofa.t(), String.t()) :: {:error, any()} | {:ok, %{}}

Check if doc exists via HEAD /:db/:doc and returns either:

• {:error, not_found} # doc doesn't exist
• {:ok, %Sofa.Doc{}} # doc exists and has metadata

@spec exists?(Sofa.t(), String.t()) :: false | true

Check if doc exists via HEAD /:db/:doc and returns either true or false

@spec from_map(map()) :: t()

Converts CouchDB-native JSON-friendly map to internal %Sofa.Doc{} format

Examples

  iex> %{ "_id" => "smol", "_rev" => "1-cute", "yes" => true}
      |> from_map()

  %Sofa.Doc{
    attachments: nil,
    body: %{"yes" => true},
    id: "smol",
    rev: "1-cute",
    type: nil
  }

@spec get(Sofa.t(), String.t()) :: {:error, any()} | t()

GET doc and returns standard HTTP status, or the requested doc

• # doc doesn't exist, or similar HTTP status
• %Sofa.Doc{} # doc exists and has metadata

@spec new(String.t() | %{}) :: t()

Creates a new (empty) document

@spec put(Sofa.t(), t()) :: {:ok, t()} | {:error, any()}

Optimistically write/update doc assuming rev matches

@spec to_map(t()) :: map()

Converts internal %Sofa.Doc{} format to CouchDB-native JSON-friendly map

Examples

  iex> %Sofa.Doc{id: "smol", rev: "1-cute", body: %{"yes" => true}}
    |> to_map()

  %{ "_id" => "smol", "_rev" => "1-cute", "yes" => true}