v0.20.2 🌻

Changes

• [Security] Bump tmpl from 1.0.4 to 1.0.5 (#1003)
• Refactor types and architecture (#1004) @bidoubiwa

With the refactor comes a better handling of info boxes:

before:

after:

Thanks again to @bidoubiwa, and @johnniehard! 🎉

v0.20.1 🌻

This package version is compatible with MeiliSearch v0.22.0 🎉

Changes

• Add get/update/delete sortable attributes methods (#995) @bidoubiwa
• Changes related to the next MeiliSearch release (v0.22.0) (#992)

Thanks again to @bidoubiwa, @curquiza! 🎉

v0.20.0 🌻

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

Changes

• Add new processing status in wait for pending update (#938) @bidoubiwa
  • Updates now return processing as their status when they are in process (see doc).
  • waitForPendingUpdate waits for the update to be both not enqueued nor processing. Meaning it may stop when encountering processed or failed.
• Implement synonyms and stop words accepting null value as update (#946) @bidoubiwa
  • null is now accepted as a parameter in updateSynonyms and updateStopWords
  • When using null as a parameter in updateSynonyms and updateStopWords the setting will be reset to their default value.
• Remove node 10 support from pre-release tests (#951) @bidoubiwa
• Add searchGet method to handle search on GET (#973) @bidoubiwa
  • Use searchGet when search requests must be done on using the GET method in the http route. This is not recommended as search is slower using GET than the default method of /search which is POST

Breaking changes ⚠️

• Rename attributesForFaceting into FilterableAttributes (#941) @bidoubiwa
  • the following method changes their name:
    getAttributesForFaceting -> getFilterableAttributes
updateAttributesForFaceting -> updateFilterableAttributes
resetAttributesForFaceting -> resetFilterableAttributes
  • updateSettings does not accept attributesForFaceting and accepts filterableAttributes as a parameter
  • See filterableAttributes documentation to understand how it works in MeiliSearch v0.21.0.
• Remove facetFilters and filters and replace with filter parameter (#944) @bidoubiwa
  • the search parameters facetFilters and filters have been merged into one search parameter called filter (without s)
  • See guide on filter to understand how it works in MeiliSearch v0.21.0
• Change fieldsDistribution to fieldDistribution (#945) @bidoubiwa
  • getStats now returns fieldDistribution attribute instead of fieldsDistribution
• Change builDate with commitDate (#937) @bidoubiwa
  • getVersion now returns a commitDate instead of a builDate
• Changes related to the next MeiliSearch release (v0.21.0) (#875)

Thanks again to @bidoubiwa, @curquiza, @erfanium, @mdubus ! 🎉

v0.19.0 🌻

Changes

• Adding the possibility to send body null and tests (#890) @alallema
• Adding delete if exists methods (#918) @sanders41
• Fixes stats cors issue (#919) @bidoubiwa
• [Security] Bump glob-parent from 5.1.1 to 5.1.2 (#917)
• [Security] Bump ws from 7.4.2 to 7.4.6 (#905)

Breaking changes ⚠️

• Remove guaranteed compatibility with versions to 10> and 15< (#914) @bidoubiwa

Thanks again to @alallema, @bidoubiwa, @curquiza, and @sanders41! 🎉

v0.18.2 🌻

Changes

• Standardize health method (#863) @alallema

Thanks again to @alallema, @bidoubiwa, @curquiza, and @react-learner! 🎉

v0.18.1 🌻

Changes

• Update types to be more accurate (#781) @bidoubiwa
• Export types that were not exported before (#781) @bidoubiwa:
  • FacetsDistribution
  • _matchesInfo
  • Hits
• Fixes getKeys() method that threw an error (#791) @bidoubiwa

Thanks again to @bidoubiwa, @curquiza, and @react-learner! 🎉

v0.18.0 🌻

Changes

• Upgrade typescript dependency from 3.9.7 to 4.1.3 (#766)

Breaking changes ⚠️

• Default export to Named export (#756) @bidoubiwa

We have changed how you import MeiliSearch-js in your project. Before this release, the import of MeiliSearch was only possible in default mode: import MeiliSearch from 'meilisearch'

New usage

ES:

import { MeiliSearch } from 'meilisearch' // ES

const client = new MeiliSearch(..)

Node

const { MeiliSearch } = require('meilisearch') // Node

const client =  new MeiliSearch(..)

Typescript usage

import { MeiliSearch, SearchResponse } from 'meilisearch' // ES

// SearchResponse

Thanks again to @bidoubiwa, @curquiza! 🎉

v0.17.1 🌻

Changes

• Fix facetsDistribution type on SearchResponse (#738) @Nick-Mazuk
• Fix double slash error and refactor api routes (#731) @bidoubiwa
• Update dependencies and fix vulnerabilities

This release is compatible with the new release of MeiliSearch with no breaking changes.
Thanks again to @Nick-Mazuk, @bidoubiwa! 🎉

v0.17.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 (#715) @bidoubiwa
• Add a new attribute in the Index class: primaryKey. You can now use client.getIndex('books').primarykey to access the primary key of your index (#715) @bidoubiwa
• client.updateIndex() lets you update an index without having to use the Index class (#715) @bidoubiwa
• client.deleteIndex() lets you delete an index without having to use the Index class (#715) @bidoubiwa
• index.fetchInfo() returns the same instance with updated information found in MeiliSearch (#715) @bidoubiwa
• Static Index.create() creates an index in MeiliSearch (#715) @bidoubiwa
• Update dependencies

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 (#715) @bidoubiwa
• index.updateIndex() is now called index.update() and now returns an Index object instead of the JSON response of MeiliSearch (#715) @bidoubiwa
• index.deleteIndex() is now called index.delete() (#715) @bidoubiwa
• index.show() is now called index.getRawInfo() (#715) @bidoubiwa
• client.getOrCreateIndex() now does at least one HTTP call (and two sometimes) (#715) @bidoubiwa

Thanks again to @bidoubiwa, @curquiza, and @eskombro ! 🎉

v0.16.1 🌻

Changes

• Add exhaustiveNbHits to SearchResponse (#688) @bb

Thanks again to @bb, and @bidoubiwa! 🎉