Skip to content

0.14.0 πŸ•Š

Compare
Choose a tag to compare
@meili-bot meili-bot released this 08 Aug 17:51
· 274 commits to refs/heads/main since this release
d0e1279

This version makes this package compatible with Meilisearch v0.28.0 πŸŽ‰
Check out the changelog of Meilisearch v0.28.0 for more information on the changes.

πŸ’₯ Breaking Changes

  • MeiliSearch#getKeys now returns a KeysResults. (#319, #321, #313) @brunoocasali
  • MeiliSearch#getIndexes now returns a IndexesResults (#319, #321, #314) @brunoocasali
  • MeiliSearch#createDump now responds with a Result<TaskInfo, Swift.Error> object. (#319, #321, #311) @brunoocasali
  • MeiliSearch#getDumpStatus was removed. Use the MeiliSearch#getTasks or MeiliSearch#getTask instead. (#311) @brunoocasali
  • Add TaskInfo type to handle enqueued tasks. (#310) @brunoocasali
  • Dump type was removed (#311) @brunoocasali.
  • SearchParameters changes (#317) @brunoocasali
    • Renamed facetsDistribution field to facets.
    • Renamed matches field to showMatchesPosition.
  • SearchResult<T> changes (#317) @brunoocasali
    • Renamed nbHits field to estimatedTotalHits.
    • Removed exhaustiveFacetsCount field.
    • Removed exhaustiveNbHits field.
  • Index#getDocuments<T> now returns an object DocumentsResults<T> (#319, #321, #312) @brunoocasali
  • MeiliSearch#getTasks and Index#getTasks now returns an object TasksResults (#319, #321, #310, #315) @brunoocasali
  • addDocuments<T>, createDump, updateSettings and other methods that "creates" a new task, now responds with a Result<TaskInfo, Swift.Error> and therefore they have a taskUid instead of uid (#310) @brunoocasali
  • MeiliSearch#updateKey method to update keys now receive a new object KeyUpdateParams (#313, #319) @brunoocasali

πŸš€ Enhancements

  • MeiliSearch#getIndexes now accepts an object with pagination IndexesQuery. (#314) @brunoocasali
  • MeiliSearch#getDocuments<T> now accepts an object with pagination DocumentsQuery. (#312) @brunoocasali
  • MeiliSearch#getDocument<T> now accepts a param called fields which takes an array of strings to remap the response. (#312) @brunoocasali
    ⚠️ Be careful with this option since T should be able to handle the missing fields.
  • MeiliSearch#createKey and MeiliSearch#deleteKey accepts both api key or api key uid. (#319, #313) @brunoocasali
  • MeiliSearch#createKey can optionally specify a uid: to generate deterministic API keys. (#319, #313) @brunoocasali
  • Refactor the request function to use a simple request builder (#283) @ppamorim
  • Add a new step into the linter action to validate Podspec (#298) @brunoocasali
  • Remove all the types from the code samples to make them simpler (#306) @brunoocasali
  • Replace all print(error) with dump(error) in the tests (#301) @nicolasvienot

Thanks again to @bidoubiwa, @brunoocasali, @meili-bors[bot], @nicolasvienot and @ppamorim! πŸŽ‰