Update to v28 (#28)

Author: jaeyson

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
     env:
       MIX_ENV: test
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      LATEST_TYPESENSE: '27.1'
+      LATEST_TYPESENSE: '28.0'
 
     strategy:
       matrix:
@@ -41,6 +41,10 @@ jobs:
           otp: '25'
           elixir: '1.14'
           lint: false
+        - typesense: '28.0'
+          otp: '25'
+          elixir: '1.14'
+          lint: false
         - typesense: '26.0'
           otp: '27'
           elixir: '1.18'
@@ -50,6 +54,10 @@ jobs:
           elixir: '1.18'
           lint: false
         - typesense: '27.1'
+          otp: '27'
+          elixir: '1.18'
+          lint: false
+        - typesense: '28.0'
           otp: '27'
           elixir: '1.18'
           lint: true

CHANGELOG.md

@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## major.minor.patch (yyyy.mm.dd)
 
+## 0.7.0 (2025.04.06)
+
+### Changed ([#28](https://github.com/jaeyson/open_api_typesense/pull/28))
+
+* Update to include Typesense [v28.0](https://typesense.org/docs/28.0/api)
+* Removed deprecated functions in `OpenApiTypesense.Client`
+* Bump dependency versions.
+* Renamed `search` to `search_collection` from `Documents` module.
+
+### Added
+
+* Tests for [stemming](https://typesense.org/docs/28.0/api/stemming.html)
+* Doc version tags
+
 ## 0.6.5 (2025.03.23)
 
 ### Changed ([#25](https://github.com/jaeyson/open_api_typesense/pull/25))

README.md

@@ -6,7 +6,7 @@ Restful client for Typesense with adherence to Open API spec 3 (formerly Swagger
 [![Hex.pm](https://img.shields.io/hexpm/v/open_api_typesense)](https://hex.pm/packages/open_api_typesense)
 [![Hexdocs.pm](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/open_api_typesense)
 [![Hex.pm](https://img.shields.io/hexpm/l/open_api_typesense)](https://hexdocs.pm/open_api_typesense/license.html)
-[![Typesense badge](https://img.shields.io/badge/Typesense-v26.0_%7C_v27.0_%7C_v27.1-darkblue)](https://typesense.org/docs/27.1/api)
+[![Typesense badge](https://img.shields.io/badge/Typesense-v26.0_%7C_v27.0_%7C_v27.1_%7C_v28.0-darkblue)](https://typesense.org/docs/27.1/api)
 [![Coverage Status](https://coveralls.io/repos/github/jaeyson/open_api_typesense/badge.svg?branch=main)](https://coveralls.io/github/jaeyson/open_api_typesense?branch=main)
 [![CI Status](https://github.com/jaeyson/open_api_typesense/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/jaeyson/open_api_typesense/actions/workflows/ci.yml)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/965dd3f8866d49c3b3e82edd0f6270cb)](https://app.codacy.com/gh/jaeyson/open_api_typesense/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
@@ -20,7 +20,7 @@ by adding `open_api_typesense` to your list of dependencies in `mix.exs`:
 ```elixir
 def deps do
   [
-    {:open_api_typesense, "~> 0.6"}
+    {:open_api_typesense, "~> 0.7"}
 
     # Or from GitHub repository, if you want the latest greatest from main branch
     {:open_api_typesense, git: "https://github.com/jaeyson/open_api_typesense.git"}

docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   typesense:
-    image: docker.io/typesense/typesense:27.1
+    image: docker.io/typesense/typesense:28.0
     container_name: typesense
     restart: on-failure
     ports:

lib/open_api_typesense/client.ex

@@ -21,26 +21,6 @@ defmodule OpenApiTypesense.Client do
           | {:error, list()}
           | :error
 
-  @doc since: "0.2.0"
-  @spec get_host :: String.t() | nil
-  @deprecated "Use OpenApiTypesense.Connection.config(:host) instead"
-  def get_host, do: Application.get_env(:open_api_typesense, :host)
-
-  @doc since: "0.2.0"
-  @spec get_scheme :: String.t() | nil
-  @deprecated "Use OpenApiTypesense.Connection.config(:scheme) instead"
-  def get_scheme, do: Application.get_env(:open_api_typesense, :scheme)
-
-  @doc since: "0.2.0"
-  @spec get_port :: non_neg_integer() | nil
-  @deprecated "Use OpenApiTypesense.Connection.config(:port) instead"
-  def get_port, do: Application.get_env(:open_api_typesense, :port)
-
-  @doc since: "0.5.0"
-  @spec get_client :: keyword() | nil
-  @deprecated "Use OpenApiTypesense.Connection.config(:client) instead"
-  def get_client, do: Application.get_env(:open_api_typesense, :client)
-
   @doc """
   Returns the Typesense's API key
 
@@ -190,12 +170,17 @@ defmodule OpenApiTypesense.Client do
     resp =
       values
       |> Enum.map(fn {module, _func_name} ->
-        if is_list(body) do
-          Enum.map(body, fn single_body ->
-            struct(module, single_body)
-          end)
-        else
-          struct(module, body)
+        cond do
+          is_list(body) ->
+            Enum.map(body, fn single_body ->
+              struct(module, single_body)
+            end)
+
+          is_nil(body) ->
+            []
+
+          true ->
+            struct(module, body)
         end
       end)
       |> List.flatten()

lib/open_api_typesense/connection.ex

@@ -75,6 +75,18 @@ defmodule OpenApiTypesense.Connection do
     raise ArgumentError, "Expected a map for connection options"
   end
 
+  @doc since: "0.6.5"
+  @spec config(atom()) :: any()
+  def config(key, default \\ nil) do
+    Access.get(config(), key, default)
+  end
+
+  @doc since: "0.6.5"
+  @spec config :: list()
+  def config do
+    Application.get_all_env(:open_api_typesense)
+  end
+
   @spec required_fields :: list(atom())
   defp required_fields do
     # Dropping :client key in order to make it optional
@@ -98,14 +110,4 @@ defmodule OpenApiTypesense.Connection do
       options: config(:options, [])
     }
   end
-
-  @spec config(atom()) :: any()
-  def config(key, default \\ nil) do
-    Access.get(config(), key, default)
-  end
-
-  @spec config :: list()
-  def config do
-    Application.get_all_env(:open_api_typesense)
-  end
 end

lib/open_api_typesense/operations/analytics.ex

@@ -1,4 +1,6 @@
 defmodule OpenApiTypesense.Analytics do
+  @moduledoc since: "0.4.0"
+
   @moduledoc """
   Provides API endpoints related to analytics
   """
@@ -12,11 +14,12 @@ defmodule OpenApiTypesense.Analytics do
 
   Sending events for analytics e.g rank search results based on popularity.
   """
+  @doc since: "0.4.0"
   @spec create_analytics_event(map()) ::
           {:ok, OpenApiTypesense.AnalyticsEventCreateResponse.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
   def create_analytics_event(body) do
-    create_analytics_event(Connection.new(), body)
+    create_analytics_event(body, [])
   end
 
   @doc """
@@ -25,6 +28,7 @@ defmodule OpenApiTypesense.Analytics do
   - `create_analytics_event(%{api_key: xyz, host: ...}, payload)`
   - `create_analytics_event(Connection.new(), payload)`
   """
+  @doc since: "0.4.0"
   @spec create_analytics_event(map() | Connection.t(), map() | keyword()) ::
           {:ok, OpenApiTypesense.AnalyticsEventCreateResponse.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
@@ -41,6 +45,7 @@ defmodule OpenApiTypesense.Analytics do
   - `create_analytics_event(%{api_key: xyz, host: ...}, payload, opts)`
   - `create_analytics_event(Connection.new(), payload, opts)`
   """
+  @doc since: "0.4.0"
   @spec create_analytics_event(map() | Connection.t(), map(), keyword()) ::
           {:ok, OpenApiTypesense.AnalyticsEventCreateResponse.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
@@ -72,11 +77,12 @@ defmodule OpenApiTypesense.Analytics do
 
   When an analytics rule is created, we give it a name and describe the type, the source collections and the destination collection.
   """
+  @doc since: "0.4.0"
   @spec create_analytics_rule(map()) ::
           {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
   def create_analytics_rule(body) do
-    create_analytics_rule(Connection.new(), body)
+    create_analytics_rule(body, [])
   end
 
   @doc """
@@ -85,6 +91,7 @@ defmodule OpenApiTypesense.Analytics do
   - `create_analytics_rule(%{api_key: xyz, host: ...}, payload)`
   - `create_analytics_rule(Connection.new(), payload)`
   """
+  @doc since: "0.4.0"
   @spec create_analytics_rule(map() | Connection.t(), map() | keyword()) ::
           {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
@@ -101,6 +108,7 @@ defmodule OpenApiTypesense.Analytics do
   - `create_analytics_rule(%{api_key: xyz, host: ...}, payload, opts)`
   - `create_analytics_rule(Connection.new(), payload, opts)`
   """
+  @doc since: "0.4.0"
   @spec create_analytics_rule(map() | Connection.t(), map(), keyword()) ::
           {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
@@ -133,11 +141,12 @@ defmodule OpenApiTypesense.Analytics do
 
   Permanently deletes an analytics rule, given it's name
   """
+  @doc since: "0.4.0"
   @spec delete_analytics_rule(String.t()) ::
           {:ok, OpenApiTypesense.AnalyticsRuleDeleteResponse.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
   def delete_analytics_rule(ruleName) do
-    delete_analytics_rule(Connection.new(), ruleName)
+    delete_analytics_rule(ruleName, [])
   end
 
   @doc """
@@ -146,6 +155,7 @@ defmodule OpenApiTypesense.Analytics do
   - `delete_analytics_rule(%{api_key: xyz, host: ...}, ruleName)`
   - `delete_analytics_rule(Connection.new(), ruleName)`
   """
+  @doc since: "0.4.0"
   @spec delete_analytics_rule(map() | Connection.t() | String.t(), String.t() | keyword()) ::
           {:ok, OpenApiTypesense.AnalyticsRuleDeleteResponse.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
@@ -162,6 +172,7 @@ defmodule OpenApiTypesense.Analytics do
   - `delete_analytics_rule(%{api_key: xyz, host: ...}, ruleName, opts)`
   - `delete_analytics_rule(Connection.new(), ruleName, opts)`
   """
+  @doc since: "0.4.0"
   @spec delete_analytics_rule(map() | Connection.t(), String.t(), keyword()) ::
           {:ok, OpenApiTypesense.AnalyticsRuleDeleteResponse.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
@@ -191,11 +202,12 @@ defmodule OpenApiTypesense.Analytics do
 
   Retrieve the details of an analytics rule, given it's name
   """
+  @doc since: "0.4.0"
   @spec retrieve_analytics_rule(String.t()) ::
           {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
   def retrieve_analytics_rule(ruleName) do
-    retrieve_analytics_rule(Connection.new(), ruleName)
+    retrieve_analytics_rule(ruleName, [])
   end
 
   @doc """
@@ -204,6 +216,7 @@ defmodule OpenApiTypesense.Analytics do
   - `retrieve_analytics_rule(%{api_key: xyz, host: ...}, ruleName)`
   - `retrieve_analytics_rule(Connection.new(), ruleName)`
   """
+  @doc since: "0.4.0"
   @spec retrieve_analytics_rule(map() | Connection.t() | String.t(), String.t() | keyword()) ::
           {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
@@ -220,6 +233,7 @@ defmodule OpenApiTypesense.Analytics do
   - `retrieve_analytics_rule(%{api_key: xyz, host: ...}, ruleName, opts)`
   - `retrieve_analytics_rule(Connection.new(), ruleName, opts)`
   """
+  @doc since: "0.4.0"
   @spec retrieve_analytics_rule(map() | Connection.t(), String.t(), keyword()) ::
           {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
@@ -250,11 +264,12 @@ defmodule OpenApiTypesense.Analytics do
   Retrieve the details of all analytics rules
 
   """
+  @doc since: "0.4.0"
   @spec retrieve_analytics_rules ::
           {:ok, OpenApiTypesense.AnalyticsRulesRetrieveSchema.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
   def retrieve_analytics_rules do
-    retrieve_analytics_rules(Connection.new())
+    retrieve_analytics_rules([])
   end
 
   @doc """
@@ -263,6 +278,7 @@ defmodule OpenApiTypesense.Analytics do
   - `retrieve_analytics_rules(%{api_key: xyz, host: ...})`
   - `retrieve_analytics_rules(Connection.new())`
   """
+  @doc since: "0.4.0"
   @spec retrieve_analytics_rules(map() | Connection.t() | keyword()) ::
           {:ok, OpenApiTypesense.AnalyticsRulesRetrieveSchema.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
@@ -279,6 +295,7 @@ defmodule OpenApiTypesense.Analytics do
   - `retrieve_analytics_rules(%{api_key: xyz, host: ...}, opts)`
   - `retrieve_analytics_rules(Connection.new(), opts)`
   """
+  @doc since: "0.4.0"
   @spec retrieve_analytics_rules(map() | Connection.t(), keyword()) ::
           {:ok, OpenApiTypesense.AnalyticsRulesRetrieveSchema.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
@@ -307,11 +324,12 @@ defmodule OpenApiTypesense.Analytics do
 
   Upserts an analytics rule with the given name.
   """
+  @doc since: "0.4.0"
   @spec upsert_analytics_rule(String.t(), map()) ::
           {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}
   def upsert_analytics_rule(ruleName, body) do
-    upsert_analytics_rule(Connection.new(), ruleName, body)
+    upsert_analytics_rule(ruleName, body, [])
   end
 
   @doc """
@@ -320,6 +338,7 @@ defmodule OpenApiTypesense.Analytics do
   - `upsert_analytics_rule(%{api_key: xyz, host: ...}, ruleName, body)`
   - `upsert_analytics_rule(Connection.new(), ruleName, body)`
   """
+  @doc since: "0.4.0"
   @spec upsert_analytics_rule(
           map() | Connection.t() | String.t(),
           String.t() | map(),
@@ -340,6 +359,7 @@ defmodule OpenApiTypesense.Analytics do
   - `upsert_analytics_rule(%{api_key: xyz, host: ...}, ruleName, body, opts)`
   - `upsert_analytics_rule(Connection.new(), ruleName, body, opts)`
   """
+  @doc since: "0.4.0"
   @spec upsert_analytics_rule(map() | Connection.t(), String.t(), map(), keyword()) ::
           {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
           | {:error, OpenApiTypesense.ApiResponse.t()}