Added ElasticsearchEx.Document struct

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 
 
+## v1.7.0
+
+* **New features:**
+  * Added a module `ElasticsearchEx.Document` to host a document from Elasticsearch
+
 ## v1.6.0 (2024-05-15)
 
 * **New features:**

lib/elasticsearch_ex/document.ex

@@ -0,0 +1,58 @@
+defmodule ElasticsearchEx.Document do
+  @moduledoc """
+  Provides a struct to represent a document from Elasticsearch.
+  """
+
+  defstruct [
+    :_id,
+    :_index,
+    :_primary_term,
+    :_seq_no,
+    :_source,
+    :_score,
+    :_version,
+    :found,
+    :result,
+    :_shards
+  ]
+
+  ## Typespecs
+
+  @type t :: %__MODULE__{
+          _id: nil | binary(),
+          _index: nil | binary(),
+          _primary_term: nil | pos_integer(),
+          _seq_no: nil | non_neg_integer(),
+          _source: map(),
+          _score: nil | float(),
+          _version: nil | pos_integer(),
+          found: nil | boolean(),
+          result: nil | binary(),
+          _shards: nil | %{required(atom() | binary()) => non_neg_integer()}
+        }
+
+  ## Public functions
+
+  def new(attrs \\ %{})
+
+  @spec new([map()]) :: [t()]
+  def new(attrs_list) when is_list(attrs_list) do
+    Enum.map(attrs_list, &new/1)
+  end
+
+  @spec new(map()) :: t()
+  def new(attrs) when is_map(attrs) do
+    case Enum.at(attrs, 0) do
+      {key, _} when is_atom(key) ->
+        struct!(__MODULE__, attrs)
+
+      {key, _} when is_binary(key) ->
+        attrs = Map.new(attrs, fn {key, value} -> {String.to_existing_atom(key), value} end)
+
+        struct!(__MODULE__, attrs)
+
+      nil ->
+        __MODULE__.__struct__()
+    end
+  end
+end

mix.exs

@@ -2,7 +2,7 @@ defmodule ElasticsearchEx.MixProject do
   use Mix.Project
 
   @source_url "https://github.com/CoreCareinc/elasticsearch_ex"
-  @version "1.6.0"
+  @version "1.7.0"
 
   def project do
     [