Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .changeset/wild-cooks-stand.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
'@meilisearch/autocomplete-client': minor
'@meilisearch/instant-meilisearch': minor
---

# Rename MeiliSearch to Meilisearch

- Following https://github.com/meilisearch/meilisearch-js/pull/2144 rename every uppercase "S" in "\*MeiliSearch\*" to lower case "s"

## Migration

```diff
- import { instantMeiliSearch } from "@meilisearch/instant-meilisearch";
+ import { instantMeilisearch } from "@meilisearch/instant-meilisearch";
// ... same pattern for every other export
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,5 @@
"vue": "3.5.25",
"vue-instantsearch": "4.22.6"
},
"packageManager": "pnpm@10.26.0"
"packageManager": "pnpm@10.33.0"
}
6 changes: 3 additions & 3 deletions packages/autocomplete-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,15 +134,15 @@ The `options` field in the `meilisearchAutocompleteClient` function provides the
- [`keepZeroFacets`](#keep-zero-facets): Show the facets value even when they have 0 matches (default `false`).
- [`requestConfig`](#request-config): Use custom request configurations.
- [`httpClient`](#custom-http-client): Use a custom HTTP client.
- [`meiliSearchParams`](#meilisearch-search-parameters): Override search parameters sent to Meilisearch.
- [`meilisearchParams`](#meilisearch-search-parameters): Override search parameters sent to Meilisearch.

```js
const client = meilisearchAutocompleteClient({
url: 'http://localhost:7700',
apiKey: 'searchKey',
options: {
// other options
meiliSearchParams: {
meilisearchParams: {
},
},
})
Expand Down Expand Up @@ -228,7 +228,7 @@ You can use your own HTTP client, for example, with [`axios`](https://github.com

### Meilisearch search parameters

`meiliSearchParams` lets you override the parameters sent to Meilisearch.
`meilisearchParams` lets you override the parameters sent to Meilisearch.
The following options can be overridden:
- [`attributesToCrop`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#attributes-to-crop)
- [`attributesToHighlight`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#attributes-to-highlight)
Expand Down
2 changes: 1 addition & 1 deletion packages/autocomplete-client/__tests__/test.utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const searchClient = meilisearchAutocompleteClient({
apiKey: API_KEY,
})

const meilisearchClient = new meilisearch.MeiliSearch({
const meilisearchClient = new meilisearch.Meilisearch({
host: 'http://localhost:7700',
apiKey: 'masterKey',
})
Expand Down
4 changes: 2 additions & 2 deletions packages/autocomplete-client/src/client/createSearchClient.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { instantMeiliSearch } from '@meilisearch/instant-meilisearch'
import { instantMeilisearch } from '@meilisearch/instant-meilisearch'
import type { SearchClient } from '../types/SearchClient.js'
import type { ClientConfig } from '../types/ClientConfig.js'

Expand All @@ -14,7 +14,7 @@ export function createSearchClient({ userAgent }: { userAgent: string }) {
options = { clientAgents: [] },
}: ClientConfig): SearchClient => {
const clientAgents = options.clientAgents || []
const { searchClient } = instantMeiliSearch(url, apiKey, {
const { searchClient } = instantMeilisearch(url, apiKey, {
...options,
clientAgents: concatUserAgents([userAgent, ...clientAgents]),
})
Expand Down
4 changes: 2 additions & 2 deletions packages/autocomplete-client/src/types/ClientConfig.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { instantMeiliSearch } from '@meilisearch/instant-meilisearch'
import { instantMeilisearch } from '@meilisearch/instant-meilisearch'
import type { MeilisearchOptions } from './MeilisearchOptions.js'

export type InstantMeilisearch = typeof instantMeiliSearch
export type InstantMeilisearch = typeof instantMeilisearch
export type MeilisearchURL = Parameters<InstantMeilisearch>[0]
export type MeilisearchApiKey = Parameters<InstantMeilisearch>[1]
export type ClientConfig = {
Expand Down
4 changes: 2 additions & 2 deletions packages/autocomplete-client/src/types/MeilisearchOptions.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
import type { InstantMeiliSearchOptions } from '@meilisearch/instant-meilisearch'
import type { InstantMeilisearchOptions } from '@meilisearch/instant-meilisearch'

export type MeilisearchOptions = InstantMeiliSearchOptions
export type MeilisearchOptions = InstantMeilisearchOptions
4 changes: 2 additions & 2 deletions packages/autocomplete-client/src/types/SearchClient.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
import type { InstantMeiliSearchInstance } from '@meilisearch/instant-meilisearch'
import type { InstantMeilisearchInstance } from '@meilisearch/instant-meilisearch'

export type SearchClient = InstantMeiliSearchInstance
export type SearchClient = InstantMeilisearchInstance
44 changes: 22 additions & 22 deletions packages/instant-meilisearch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,15 +134,15 @@ To be able to create a search interface, you'll need to [install `instantsearch.
### Basic

```js
import { instantMeiliSearch } from '@meilisearch/instant-meilisearch'
import { instantMeilisearch } from '@meilisearch/instant-meilisearch'

const { searchClient, setMeiliSearchParams } = instantMeiliSearch(
const { searchClient, setMeilisearchParams } = instantMeilisearch(
'https://ms-adf78ae33284-106.lon.meilisearch.io', // Host
'a63da4928426f12639e19d62886f621130f3fa9ff3c7534c5d179f0f51c4f303' // API key
)
```

where `searchClient` is to be passed to instantsearch.js or its many framework adaptations, and [`setMeiliSearchParams`](#modify-meilisearch-search-parameters) is a function used to set/modify certain Meilisearch search parameters to be overridden.
where `searchClient` is to be passed to instantsearch.js or its many framework adaptations, and [`setMeilisearchParams`](#modify-meilisearch-search-parameters) is a function used to set/modify certain Meilisearch search parameters to be overridden.

### Parameters

Expand All @@ -159,14 +159,14 @@ where `searchClient` is to be passed to instantsearch.js or its many framework a
- [`keepZeroFacets`](#keep-zero-facets): Show the facets value even when they have 0 matches (default `false`).
- [`requestInit`](#request-config): Use custom request configurations.
- [`httpClient`](#custom-http-client): Use a custom HTTP client.
- [`meiliSearchParams`](#meilisearch-search-parameters): Override a selection of Meilisearch search parameters (default `undefined`).
- [`meilisearchParams`](#meilisearch-search-parameters): Override a selection of Meilisearch search parameters (default `undefined`).

The options are added as the third parameter of the `instantMeilisearch` function.

```js
import { instantMeiliSearch } from '@meilisearch/instant-meilisearch'
import { instantMeilisearch } from '@meilisearch/instant-meilisearch'

const { searchClient } = instantMeiliSearch(
const { searchClient } = instantMeilisearch(
'https://ms-adf78ae33284-106.lon.meilisearch.io',
'a63da4928426f12639e19d62886f621130f3fa9ff3c7534c5d179f0f51c4f303',
{
Expand Down Expand Up @@ -277,10 +277,10 @@ Search metadata is useful for interacting with the [Meilisearch Analytics Events
The search client returns `MeilisearchSearchResponse` which extends the standard `AlgoliaSearchResponse` with an optional `_meilisearch` namespace containing metadata:

```ts
import { instantMeiliSearch, getAnalyticsMetadata } from '@meilisearch/instant-meilisearch'
import { instantMeilisearch, getAnalyticsMetadata } from '@meilisearch/instant-meilisearch'
import instantsearch from 'instantsearch.js'

const { searchClient } = instantMeiliSearch(
const { searchClient } = instantMeilisearch(
'https://ms-adf78ae33284-106.lon.meilisearch.io',
'a63da4928426f12639e19d62886f621130f3fa9ff3c7534c5d179f0f51c4f303'
)
Expand Down Expand Up @@ -367,7 +367,7 @@ connectHits(renderHits)
For self-hosted Meilisearch instances, you need to enable search metadata by setting the `Meili-Include-Metadata` header:

```ts
const { searchClient } = instantMeiliSearch(
const { searchClient } = instantMeilisearch(
'http://localhost:7700',
'your-api-key',
{
Expand All @@ -382,7 +382,7 @@ const { searchClient } = instantMeiliSearch(

### Meilisearch search parameters

`meiliSearchParams` lets you override a set of search parameters that are sent off to Meilisearch.
`meilisearchParams` lets you override a set of search parameters that are sent off to Meilisearch.
The following options can be overridden:
- [`attributesToCrop`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#attributes-to-crop)
- [`attributesToHighlight`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#attributes-to-highlight)
Expand All @@ -399,10 +399,10 @@ The following options can be overridden:
- [`rankingScoreThreshold`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#ranking-score-threshold)

```js
instantMeiliSearch(
instantMeilisearch(
// ...
{
meiliSearchParams: {
meilisearchParams: {
attributesToHighlight: ['overview'],
highlightPreTag: '<em>',
highlightPostTag: '</em>',
Expand All @@ -414,10 +414,10 @@ instantMeiliSearch(
When using multi search, meilisearchParams can be overriden for specific indexes :

```js
instantMeiliSearch(
instantMeilisearch(
// ...
{
meiliSearchParams: {
meilisearchParams: {
// All indexes will highlight overview
attributesToHighlight: ['overview'],
highlightPreTag: '<em>',
Expand All @@ -435,20 +435,20 @@ instantMeiliSearch(
```
### Modify Meilisearch search parameters

`instantMeiliSearch` returns an instance with two properties on it, one of them being `setMeiliSearchParams`.
`instantMeilisearch` returns an instance with two properties on it, one of them being `setMeilisearchParams`.

```js
const { searchClient, setMeiliSearchParams } = instantMeiliSearch(/*...*/)
const { searchClient, setMeilisearchParams } = instantMeilisearch(/*...*/)
```

It modifies (or sets if not already set) the [overridden Meilisearch search parameters](#meilisearch-search-parameters).
It only modifies parameters that are defined on the provided object, the following will not change `attributesToHighlight`.

```js
const { setMeiliSearchParams } = instantMeiliSearch(
const { setMeilisearchParams } = instantMeilisearch(
// ...
{
meiliSearchParams: {
meilisearchParams: {
attributesToHighlight: ['overview'],
highlightPreTag: '<em>',
highlightPostTag: '</em>',
Expand All @@ -457,7 +457,7 @@ const { setMeiliSearchParams } = instantMeiliSearch(
}
)

setMeiliSearchParams({
setMeilisearchParams({
highlightPreTag: '<mark>',
highlightPostTag: '</mark>',
attributesToSearchOn: ['overview', 'title'],
Expand Down Expand Up @@ -495,7 +495,7 @@ In `index.html`:
In `app.js`:

```js
const { searchClient } = instantMeiliSearch(
const { searchClient } = instantMeilisearch(
'https://ms-adf78ae33284-106.lon.meilisearch.io',
'a63da4928426f12639e19d62886f621130f3fa9ff3c7534c5d179f0f51c4f303'
)
Expand Down Expand Up @@ -620,11 +620,11 @@ List of all the components that are available in [instantSearch](https://github.
```js
const search = instantsearch({
indexName: 'instant_search',
searchClient: instantMeiliSearch(
searchClient: instantMeilisearch(
'https://ms-adf78ae33284-106.lon.meilisearch.io',
'a63da4928426f12639e19d62886f621130f3fa9ff3c7534c5d179f0f51c4f303',
{
// ... InstantMeiliSearch options
// ... InstantMeilisearch options
}
).searchClient,
// ... InstantSearch options
Expand Down
10 changes: 5 additions & 5 deletions packages/instant-meilisearch/__tests__/assets/utils.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { instantMeiliSearch } from '../../src/index.js'
import { MeiliSearch } from 'meilisearch'
import { instantMeilisearch } from '../../src/index.js'
import { Meilisearch } from 'meilisearch'
Comment thread
flevi29 marked this conversation as resolved.

const HOST = 'http://localhost:7700'
const API_KEY = 'masterKey'
Expand Down Expand Up @@ -309,15 +309,15 @@ export type Movies = {
_highlightResult?: Movies
}

const { searchClient } = instantMeiliSearch(
const { searchClient } = instantMeilisearch(
'http://localhost:7700',
'masterKey'
)
const { searchClient: wrongSearchClient } = instantMeiliSearch(
const { searchClient: wrongSearchClient } = instantMeilisearch(
'http://localhost:7777',
'masterKey'
)
const meilisearchClient = new MeiliSearch({
const meilisearchClient = new Meilisearch({
host: HOST,
apiKey: API_KEY,
})
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe, beforeAll, test, expect, vi } from 'vitest'
import { instantMeiliSearch } from '../src/index.js'
import { instantMeilisearch } from '../src/index.js'
import { meilisearchClient, dataset } from './assets/utils.js'

describe('Custom HTTP client tests', () => {
Expand All @@ -18,7 +18,7 @@ describe('Custom HTTP client tests', () => {
return await result.json()
})

const { searchClient } = instantMeiliSearch(
const { searchClient } = instantMeilisearch(
'http://localhost:7700',
'masterKey',
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe, beforeAll, test, expect } from 'vitest'
import { instantMeiliSearch } from '../src/index.js'
import { instantMeilisearch } from '../src/index.js'
import { type Movies, meilisearchClient } from './assets/utils.js'
import movies from './assets/movies.json' with { type: 'json' }
import games from './assets/games.json' with { type: 'json' }
Expand All @@ -26,7 +26,7 @@ describe('Keep zero facets tests', () => {
})

test('searching on one index with facet filtering', async () => {
const { searchClient: customClient } = instantMeiliSearch(
const { searchClient: customClient } = instantMeilisearch(
'http://localhost:7700',
'masterKey',
{
Expand Down Expand Up @@ -94,7 +94,7 @@ describe('Keep zero facets tests', () => {
})

test('searching on two indexes with facet filtering', async () => {
const { searchClient: customClient } = instantMeiliSearch(
const { searchClient: customClient } = instantMeilisearch(
'http://localhost:7700',
'masterKey',
{
Expand Down Expand Up @@ -242,7 +242,7 @@ describe('Keep zero facets tests', () => {
})

test('searching on two indexes with facet filtering and keep zero facets', async () => {
const { searchClient: customClient } = instantMeiliSearch(
const { searchClient: customClient } = instantMeilisearch(
'http://localhost:7700',
'masterKey',
{
Expand Down Expand Up @@ -412,7 +412,7 @@ describe('Keep zero facets tests', () => {
})

test('searching on an index with facet filtering with some and operators', async () => {
const { searchClient: customClient } = instantMeiliSearch(
const { searchClient: customClient } = instantMeilisearch(
'http://localhost:7700',
'masterKey',
{
Expand Down Expand Up @@ -463,7 +463,7 @@ describe('Keep zero facets tests', () => {
})

test('searching on an index with facet filtering with some and operators with keep zero facets', async () => {
const { searchClient: customClient } = instantMeiliSearch(
const { searchClient: customClient } = instantMeilisearch(
'http://localhost:7700',
'masterKey',
{
Expand Down
Loading
Loading