CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

major.minor.patch (yyyy.mm.dd)

2.3.0 (2026.04.14)

Chore

• Update compatibility to include Typesense v30.1
• Add tests to include v30.1
• CI to include v30.1

2.2.0 (2026.04.14)

Added

• ExTypesense.CurationSets

Chore

• Update compatibility to include Typesense v30.0

Deprecated

• ExTypesense.upsert_search_synonym/4 in favor of upsert_synonym_set/3 or upsert_synonym_set_item/4 when using Typesense v30.0+.
• ExTypesense.get_search_synonyms/2 in favor of retrieve_synonym_set_items/2 or retrieve_synonym_sets/1 when using Typesense v30.0+.
• ExTypesense.get_search_synonym/3 in favor of retrieve_synonym_set/2 or retrieve_synonym_set_item/3 when using Typesense v30.0+.
• ExTypesense.delete_search_synonym/3 in favor of delete_synonym_set/2 or delete_synonym_set_item/3 when using Typesense v30.0+.

2.1.0 (2026.04.13)

Chore

• Update compatibility to include Typesense v29.0
• Added ExTypesense.NaturalLanguage operation
• Added ExTypesense.flush_analytics/1
• Added ExTypesense.get_analytics_status/1
• Added ExTypesense.get_analytics_events/1
• Added tests for new operations

Removed

• Operations.config/2. Use Operations.toggle_slow_request_log/2

2.0.0 (2025.06.01)

Changed

• Passing conn as part of opts when calling a function, as this reduces code duplication. PR #82

Chore

• Bumped dev dependencies

1.2.1 (2025.05.11)

Fixed

• Remove collection_name field in return value when indexing or updating a document via map. Issue #77 PR #78

1.2.0 (2025.04.06)

Added

• Stemming module
• Tests for new module
• ExTypesense.get_schema_changes
• Support for Typesense v28.0

Changed

• Pass union key on multi search
• Bump dependency version.

Removed

• ExTypesense.get_collection_name, use ExTypesense.get_collection_alias

1.1.1 (2025.03.26)

Changed

• Bump dependency version.

1.1.0 (2025.03.02)

Added

• Collection.create_collection_with_alias/1.
• Allow module name (atom) to be passed as alias name in Collection.create_collection_with_alias/1.
• Typespec to pass also omodule name (atom) for Collection.create_collection_with_alias/1.
• Separate dev and test environments.

Fixed

• Typespecs for Search.multi_search_ecto.
• Return values of Search.multi_search_ecto for search_test.exs.

Deprecated

• Collection.get_collection_name/1

1.0.2 (2025.01.30)

Changed

• Bump dependency version.

1.0.1 (2025.01.26)

Changed

• Bump dependency version.
• README banner image

1.0.0 (2025.01.19)

Added

• External docs link for example of using another HTTP client.
• More test coverage

Changed

• Backwards-incompatible changes, in favor of using OpenApiTypesense.
• Bump dependencies
• CI to support Typesense versions v26.0, v27.0, v27.1

Removed

• Dropped support for Typesense version v0.25.2
• ExTypesense.ResultParser module (moved to ExTypesense.Search)

Deprecated

• Dropped support for Typesense v0.25.2

0.7.3 (2024.11.11)

Added

• {:error, String.t()} type for Search.search/3

0.7.2 (2024.11.07)

Changed

• Use v27.1 of Typesense in CI and local development.

0.7.1 (2024.09.10)

Removed

• :castore dependency not passing on CI test

0.7.0 (2024.09.10)

Changed

• HTTP request construction in ExTypesense.HttpClient to include options.
• Bumped dependencies

Added

• options in config config/config.exs.
• get_options/0 function in HttpClient to fetch the options configuration.
• tests for get_options/0 in ExTypesense.HttpClientTest.

0.6.0 (2024.07.15)

Changed

• Move application env variables from test_helper.exs to config directory, in usage for both dev and test environments.

Added

• Function: multi search

0.5.0 (2024.07.13)

Changed

• README regarding default_sorting_field, where it joins the table name with _id (e.g. images is images_id instead of image_id).

Added

• Function: delete by query.
• Function: delete all documents in a collection.
• Collection's schema field parameters:
  • :vec_dist
  • :store
  • :reference
  • :range_index
  • :stem

Removed

• HttpClient.run and HttpClient.httpc_run function (use HttpClient.request).

0.4.3 (2024.07.03)

Changed

• README regarding test and connection strings.
• Replacing connection struct to map.

0.4.2 (2024.06.19)

Changed

• README and cheatsheet details regarding on setup for creation of collection schema.

0.4.1 (2024.06.11)

Changed

• README on running docker compose.

0.4.0 (2024.05.20)

Added

• Connection module for dynamic loading of credentials.
• Default connection config when running commands (e.g. create collections, etc.).

Changed

• Refactor ExTypesense.HttpClient on how to handle request.
• Bumped dependencies' version.
• Dropped usage of :httpc in favor of using Req library.

Deprecated

• Some functions from Document and HttpClient where soft depcrated in order to incorporate the Connection module for dynamic connections loaded from Ecto schema. If you read the docs, you might notice it's marked with deprecated and encourages to use the newer ones.

0.3.5 (2023.08.13)

Fixed

• Fixed typos

0.3.4 (2023.07.12)

Changed

• Remove string conversion on struct id when deleting a document.

0.3.3 (2023.07.11)

Added

• Add index_multiple_documents/1 clause for accepting struct args.

0.3.2 (2023.07.11)

Changed

• Maps struct pk to document's id.
• Update http request timeout to 3,600 seconds.

0.3.1 (2023.07.11)

Changed

• Increase connection timeout.

0.3.0 (2023.06.20)

Fixed

• Fixed url request path for aliases.

Changed

• Refactor functions inside collection and document.
• Changed return values from {:ok, t()} to t() only.
• Parse schema field types for float, boolean, string, integer and a list with these corresponding types.

Added

• Added cheatsheet section on docs.

0.2.2 (2023.01.26)

Changed

• Updated docs

0.2.1 (2023.01.22)

Changed

• Returned an ecto query instead of list of results.

0.2.0 (2023.01.20)

Added

• Added search function which returns a list of structs or empty.

0.1.0 (2023.01.20)

• Initial release