feature: handle per index meilisearch params

[8byr0]

Pull Request

Related issue

Fixes #1361

What does this PR do?

• Allow configuring meilisearchParams for each index individually (multi search)

From :

const client = instantMeiliSearch(
      "host",
      "key",
      {
        meiliSearchParams: {
          matchingStrategy: MatchingStrategies.ALL,
        },
      },
    ).searchClient;

To :

const client = instantMeiliSearch("host", "key", {
  meiliSearchParams: {
    indexesOverrides: {
      products: { matchingStrategy: MatchingStrategies.ALL },
      categories: { matchingStrategy: MatchingStrategies.LAST },
    },
  },
}).searchClient

PR checklist

Please check if your PR fulfills the following requirements:

• Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
• Have you read the contributing guidelines?
• Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

[changeset-bot]

⚠️ No Changeset found

Latest commit: e6ae639

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[8byr0]

My initial proposal in #1364 was to be able to override directly like :

const client = instantMeiliSearch(
      "host",
      "key",
      {
        meiliSearchParams: {
          products: { matchingStrategy: MatchingStrategies.ALL },
          categories: { matchingStrategy: MatchingStrategies.LAST },
        },
      },
    ).searchClient;

Unfortunately as far as I've seen it's not possible using typescript

This one works fine for accessing the values

export type OverridableMeiliSearchSearchParameters = BaseMeiliSearchSearchParameters & {
  [K in Exclude<string, keyof BaseMeiliSearchSearchParameters>]?: BaseMeiliSearchSearchParameters;
};

// No TS errors
const res = myobject[indexName].attributesToRetrieve;

// TS error
const meiliSearchParams: OverridableMeiliSearchSearchParameters = {
      attributesToHighlight: ['movies', 'genres'],
      highlightPreTag: '<em>',
      highlightPostTag: '</em>',
      matchingStrategy: MatchingStrategies.ALL,
    }

This one works fine for declaring values

export type OverridableMeiliSearchSearchParameters =
  | BaseMeiliSearchSearchParameters
  | (BaseMeiliSearchSearchParameters & {
      [K in Exclude<
        string,
        keyof BaseMeiliSearchSearchParameters
      >]?: BaseMeiliSearchSearchParameters
    })

// TS errors
const res = myobject[indexName].attributesToRetrieve;

// No TS errors
const meiliSearchParams: OverridableMeiliSearchSearchParameters = {
      attributesToHighlight: ['movies', 'genres'],
      highlightPreTag: '<em>',
      highlightPostTag: '</em>',
      matchingStrategy: MatchingStrategies.ALL,
    }

Open to discuss it if anyone has another approach in mind

[Strift]

Thank you for opening this PR, I will take a look and review it ASAP.

[8byr0]

Just realised the override mechanism was not setup for filters and facets arguments so I added it in the same way as others (latest commit)

[8byr0]

@Strift any update on this ?