types: fix search default type of search and searchGet

[trim21]

Pull Request

Related issue

No

What does this PR do?

This pr fix the default genetic type params of search and searchGet, it should use generic type param of index

expected type behavior in readme

client.index<T>('xxx').search(...): Promise<SearchResponse<T>>

current actually type, because search has a default generic type param Record<string, any>:

client.index<T>('xxx').search(...):

is implicit

client.index<T>('xxx').search<Record<string, any>>(...):

and it's actually

client.index<T>('xxx').search(...): Promise<SearchResponse<Record<string, any>>>

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!

[trim21]

and what's the point of Document?

meilisearch-js/src/types/types.ts

Lines 164 to 165 in 9ddf65d

	export type Document<T = Record<string, any>> = T
	export type Documents<T = Record<string, any>> = Array<Document<T>>

Document<T> is just T, should it be export type Document<T extends Record<string, any>> = T?
Documents<T> is just Array<T>, should it also be export type Documents<T extends Record<string, any>> = Array<Document<T>> ?

[bidoubiwa]

In typed_search.test.ts

Could you also add the following? That's what is failing the tests

export interface Movie {
  id: number
  title: string
  genre?: string
  comment?: string
  isNull?: null
  isTrue?: true
}

interface NestedDocument {
  id: number
  title: string
  info: {
    comment?: string
    reviewNb?: number
  }
}

const dataset: Movie[] = [

I know this is not the best design 😅 We'll work on that later

[trim21]

I fixed this error by add isNull in both Movie object.

do you perfer @ts-ignore or @ts-expect-error here?

[trim21]

it's still '1 change requested', any thing I need to do?

[bidoubiwa]

Document is just T, should it be export type Document<T extends Record<string, any>> = T?
Documents is just Array, should it also be export type Documents<T extends Record<string, any>> = Array<Document> ?

You'r right, Document is just T. I made a Type mostly for readability to avoid writing a long type in the method prototype.

With the same logic as with getSearch and search, I think it should be D = T.

What do you think?

[trim21]

if Document<T> is just T then I think we should just remove it.

[bidoubiwa]

Yep, should be removed

[trim21]

so is there anything blocking this PR now？

[bidoubiwa]

Oh I thought you were going to remove Document in this PR as well. My bad :) I'll open an issue for that

[bidoubiwa]

LGTM 🔥

[bidoubiwa]

bors merge

[trim21]

Oh I thought you were going to remove Document in this PR as well. My bad :) I'll open an issue for that

Removing it is not very related to this pr I this, should be separated to another pr…

[meili-bors]

Build succeeded:

• integration-tests (Node.js 14)
• integration-tests (Node.js 16)
• integration-tests (Node.js 18)
• style-check
• types-check

[bidoubiwa]

#1421