feat(types): support type and facet in search methods

[francoischalifour]

Description

The engine recently added support for facet value search from the search and multipleQueries method.

This PR updates the MultipleQueriesQuery to reflect this change.

Usage

searchClient
  .search([
    {
      indexName: 'instant_search',
      query: 'a',
    },
    {
      type: 'facet',
      indexName: 'instant_search',
      facet: 'categories',
      query: 'a',
    },
  ])
  .then(({ results }) => {
    console.log(results);
  });

Related

• Query object documentation

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 0df02d5:

Sandbox	Source
javascript-client-app	Configuration

[Haroenv]

this being optional means that facet is allowed without type. I'm not sure how to solve this, it seems like a limitation of TS

https://www.typescriptlang.org/play?#code/C4TwDgpgBAygFgQwE4QCZQLxQN5QJYB2qEAHgHIIC2EAXFAM7BKEDmUAvgNwBQ3okUAPIEAxtCzxkaKADJuUBVAAU8xWoA+OKPwgB+OgQgA3CEg6q1CzdguW1OugHJiAMwQBXADbBHPOwvZbDRwg-wcoRzcxHz9-NQB6ACpE0P9EqAAVOGgoiGAoAioIADpUu0T4srVc4DpGZgIWWLt2AEoebnj4qAB3OBAoVAB7AqHDKCGXbWz6aEQTKFMkIaR6XW4RMcYJ0VohXcwtQmJyIqdgCEZHDh4gA

https://stackoverflow.com/questions/41495369/typescript-discriminated-unions-with-optional-values

[eunjae-lee]

https://www.typescriptlang.org/play?#code/C4TwDgpgBAygFgQwE4QCZQLxQN5QJYB2qEAHgHIIC2EAXFAM7BKEDmUAvgNwBQ3okUAPIEAxtCzxkaKADJuUBVAAU8xWoA+OKP1pQCEAG4QkHVWoWbsZ82p10A5MQBmCAK4AbYPZ42F7axo4Ab52UPYuYl4+vmoA9ABU8cG+8VAAKnDQERDAelQQAHTJNvGxxWrZwHSMzAQs0TbsAJQ83LGxUADucCBQqAD2ev36UP1O2pn00IhGUMZI-Uj0APzcIsOMo6K6wmKYWoTE5PkOwBCM9gA0UJUOCPYcPEA

it sort of works?

[Haroenv]

the problem is that it allows const once: Once = { indexName: 'test', facet: "lol" }; which is invalid

[eunjae-lee]

From my link, it gives an error message with that.

https://www.typescriptlang.org/play?#code/C4TwDgpgBAygFgQwE4QCZQLxQN5QJYB2qEAHgHIIC2EAXFAM7BKEDmUAvgNwBQ3okUAPIEAxtCzxkaKADJuUBVAAU8xWoA+OKP1pQCEAG4QkHVWoWbsZ82p10A5MQBmCAK4AbYPZ42F7axo4Ab52UPYuYl4+vmoA9ABU8cG+8VAAKnDQERDAelQQAHTJNvGxxWrZwHSMzAQs0TbsAJQ83LGxUADucCBQqAD2ev36UP1O2pn00IhGUMZI-Uj0APzcIsOMo6K6wmKYWoTE5PkOwBCM9gA02uC6jhAuHl4cPOsEm8CdeGJ0u+IHRFIFGop3OXmulQc7n67nsL24QA

[shortcuts]

nevermind

[Haroenv]

yes, but that type doesn't allow type to be omitted:

In the end the one in this PR might be the best

[eunjae-lee]

Ah I misunderstood your intention.

[eunjae-lee]

Looks good to me.

[Haroenv]

not perfect, but I don't see an alternative