v0.7.0 ☕️

This package version is compatible with MeiliSearch v0.25.0 (#296)

⚠️ Breaking changes

• This package is only compatible with MeiliSearch v0.25.0 and later, but not with v0.24.0 and older. Be sure you are using at least MeiliSearch v0.25.0 or newer before doing the upgrade.
  Why isn't it compatible?
  • MeiliSearch v0.25.0 use Authorization header instead of X-Meili-API-Key (#306) @alallema
  • MeiliSearch v0.25.0 has a new API regarding the updates that have been renamed into tasks. More details in the following points
• Remove deleteIfExist and getOrCreate (#307) (#308) @alallema
• Redesign API update by task (#311) @alallema
  • All the actions on indexes are now asynchronous check out the task API references and the asynchronous tasks guide
    • createIndex(), updateIndex(), deleteIndex() are now asynchrone and return a Yask response instead of an Index.
    • index.create and index.delete from index return a Task.
    • waitForPendingUpdate() is renamed into waitForTask and is accessible from index and from client.
    • the current index.waitForTask() method call /tasks/:uid
    • index.getUpdateStatus is renamed index.getTask
    • index.getAllUpdateStatus is renamed index.getTasks
    • new method client.waitForTask() call /tasks/:uid
    • new method client.waitForTask()
    • new method client.getTasks that calls /tasks
    • new method client.getTask that calls /tasks/:uid
      Notes: The only two methods that now return an Index are client.index() and client.get_index()
• Change client.getKeys does not return an object of keys, but an array of keys. Check out keys API references.
• Changes related to the next MeiliSearch release (v0.25.0) (#296)

🚀 Enhancements

• Addition related to API keys (#317) @alallema
  • Granular management of API keys is now added to MeiliSearch. New methods have been created to manage this:
    • client.getKey get information about a specific API key.
    • client.createKey create a new API key.
    • client.deleteKey delete an API key.
    • client.updateKey update an API key.
  • Check out the documentation guide.
• Add the possibility to add documents in batches and update documents in batches (#305) @diegonavarroq

🐛 Bug Fixes

• Change type for variable of databaseSize (#299) @diegonavarroq
• make Class Error accesible (#303) @Artumira96

Thanks again to @Artumira96, @alallema, @diegonavarroq, @irenejoeunpark ! 🎉

v0.6.0 ☕️

This package version is compatible with MeiliSearch v0.24.0

⚠️ Breaking changes

• Rename errorCode, errorLink, errorType and errorMessage in code, link, type and message (#280) @alallema
• Update the error change in UpdateStatus class but create error object containing code, link and type (#282) @alallema

🚀 Enhancements

• Add offset and attributesToRetrieve parameter to get docum… (#247) @ezienecker
• Add delete index if exists method (#248) @ezienecker
• Add RUD operations for ranking rule settings (#254) @ezienecker
• Implement sub-settings methods (#264) @ezienecker

Thanks again to @Hard-Coder05, @alallema, @curquiza, @ezienecker, @irenejoeunpark, and @ujjavala! 🎉

v0.5.0 ☕️

This package version is compatible with MeiliSearch v0.23.0

Changes

• addDocuments and updateDocuments take primaryKey as optional param (#224) @vishnugt
• Added getRawIndex and getRawIndexList methods (#239) @vishnugt

Breaking changes ⚠️

• Add support for filter arrays and nested filters in filter search (#222) @vishnugt

Thanks again to @alallema, @ansavanix, @curquiza, @inomag, @ishika22, @mohitsaxenaknoldus, and @vishnugt! 🎉

v0.4.1 ☕️

This package version is compatible with MeiliSearch v0.22.0 🎉

Changes

• Add sort feature compatibility (#204) @alallema. More about sorting.
  • Add sortable attributes methods: get_sortable_attributes, set_sortable_attributes, reset_sortable_attributes.
  • Add sort parameter during search.

Thanks again to @alallema! 🎉

v0.4.0 ☕️

This version makes this package compatible with MeiliSearch v0.21.0
🎉 Check out the changelog of MeiliSearch v0.21.0

Changes

• Add Fields in Dump (#180) @alallema
• Add facets distribution fields in search request (#185) @alallema

Breaking changes ⚠️

• Rename of buildDate into commitDate (#177) @alallema
• Rename attributes_for_faceting into filterable_attributes (#178) @alallema
• Rename FieldsDsitribution into FieldDistribution (#179) @alallema
• Rename Filters into Filter (#181) @alallema
• Changes related to the next MeiliSearch release (v0.21.0) (#157)

Thanks again to @alallema, @curquiza, and @ppshobi! 🎉

v0.3.1 ☕️

Changes

• Standardize health method (#171) @alallema

Thanks again to @alallema, @curquiza, @eskombro! 🎉

v0.3.0 ☕️

Changes

• BasicHttpRequest Enconding with UTF-8 (#132) @chboing
• Implement APIs based on ServiceTemplate (#121 #122) @niemannd
• Add package version to Jupiter (#119) @fharper

Breaking changes ⚠️

• Improve error handling (#120) @niemannd
• Response with generic class for Search (#108) @djKooks

Thanks again to @chboing, @curquiza, @djKooks, @eskombro, @fharper, @nicolasvienot, @niemannd, @React-learner and Christophe BECKERICH! 🎉

v0.2.0 ☕️

Changes

• Introduction of the index() method that replaces getIndex(). getIndex() is still available but does HTTP call, so this should be only used to fetch information from the MeiliSearch instance. See our Getting Started to use this package the right way (#74) @eskombro
• Add a fetchPrimaryKey() method to Index class. The attribute primaryKey is not updated when using the index() method: the method does not do any HTTP call. Refer to the limitation section in the main issue. (#74) @eskombro
• Change of get method to post method in the sdk (#75) @mayralgr
• Added update method with the test (#81) @JohanDelValleV
• Implement dumps (#89) @luis-valdez
• Implement setting methods (#95) @luis-valdez
• implement ServiceTemplate (#92) @niemannd

Breaking changes ⚠️

• getIndex() is still present but does an HTTP call. This method should be only used to fetch information from the MeiliSearch instance, not to manipulate an Index object in your code base. Use index() instead. See our Getting Started to be sure using this SDK the most optimized way (#74) @eskombro
• client.getOrCreateIndex() now does at least one HTTP call (and two sometimes) (#74) @eskombro
• Refactor update index method: returns now an Index instance (#83) @luis-valdez

Thanks again to @JacobSherrod, @JohanDelValleV, @curquiza, @djKooks, @eskombro, @luis-valdez, @mayralgr, @niemannd, and kination! 🎉

v0.1.1 ☕️

This package is now officially available for production!

Changes

• Update dependencies

Thanks to @curquiza, and @eskombro! 🎉

v0.1.0

First version of this SDK!! 🎉
Still a WIP, but available for production soon!

Thanks to @eskombro, @niemannd, @djKooks, @AmiralBl3ndic and @arjunrc143!!! A huge work has been done here! ❤️