Update version for the next release (v0.27.0) #1294
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
client.updateKey(key: string, options: KeyPayload): Promise<Key>now can just update thedescriptionand/or the name. Update key management v0.28 #1266EnqueuedTasknow returns antaskUidinstead of anuidclient.getTasks(...)andindex.getTasks()now returns a TasksResults type containing the following fields:results,limit,from,nextAdd pagination system on resources for v0.28.0 #1269index.searchchanges in the response parameters: Update search method v0.28 #1263nbHitsreplaced withestimatedTotalHitsexhaustiveNbHitsis deletedexhaustiveFacetsCountis deletedindex.searchchanges in the request parameters: Update search method v0.28 #1263matchesrenamedshowMatchesPosition_matchesInforesponse parameter is renamed_matchesPositionfacetsDistributionrequest parameter is renamedfacets.facetsDistributionresponse parameter is renamedfacetDistribution.Indextype and returnedIndexObjectdoes not contain anamefield anymoreclient.getIndexesandclient.getRawIndexesnow returns anIndexesResultstype containing the following fields:results,limit,offset,totalAdd pagination system on resources for v0.28.0 #1269index.getDocumentsandclient.getDocumentsnow returns anDocumentsResultstype containing the following fields:results,limit,offset,totalAdd pagination system on resources for v0.28.0 #1269index.getDocumentsandindex.getDocumentquery parameterattributesToRetrieveis now calledfieldsUpdate documents method v0.28 #1264client.getDumpStatushas been removed Update dumps method v0.28 #1267client.createDump()now returns anEnqueuedTaskUpdate dumps method v0.28 #1267client.generateTenantToken(apiKeyUid, searchRules, options)has now a mandatoryapiKeyUidparameter which should contain the uid of a specific API key. Update token creation v0.28.0 #1268🚀 Enhancements
client.getKeys(parameters: KeysQuery = {})now accepts pagination parameters:limit,offsetAdd pagination system on resources for v0.28.0 #1269client.getKey(keyOrUid: string)can now also find keys based on their key uid. Update key management v0.28 #1266client.createKey(options: KeyCreation)lets you specify a custom uid (optionally) to create a new Key Add pagination system on resources for v0.28.0 #1269Keynow has an additionalnameanduidstring fields. Update key management v0.28 #1266indexUidfield in bothEnqueuedTaskandTaskcan be null Update tasks routes #1259client.getTasks(parameters: TasksQuery = {})andindex.getTasks(parameters: TasksQuery)now accepts pagination parameters:limit,from,nextand filters parameters:type,status,indexUid(same forindex.getTasks) Add pagination system on resources for v0.28.0 #1269client.getIndexesandclient.getRawIndexesnow accepts pagination parameters:limit,offsetAdd pagination system on resources for v0.28.0 #1269index.getDocumentsnow accepts pagination parameters:limit,offsetAdd pagination system on resources for v0.28.0 #1269new MeiliSearch({ host, apiKey, headers, clientAgents })now accept a new parameterclientAgentsthat should contain the agent from which the library is used. Add client header with package information #1272Analytics is enabled by default in the server, but you can disable them by following this guide
Also, of course, every analytics data we collect are ANONYMOUS read the guide for more information.
Thanks again to @bidoubiwa ! 🎉