Merge branch 'main' into tsdoc

Author: trim21

package.json

@@ -74,7 +74,7 @@
   "devDependencies": {
     "@babel/preset-env": "^7.20.2",
     "@rollup/plugin-babel": "^6.0.3",
-    "@rollup/plugin-commonjs": "23.0.3",
+    "@rollup/plugin-commonjs": "23.0.4",
     "@rollup/plugin-json": "^5.0.2",
     "@rollup/plugin-node-resolve": "15.0.1",
     "@types/jest": "^27.5.0",

playgrounds/javascript/yarn.lock

@@ -4145,9 +4145,9 @@ q@^1.1.2:
   integrity sha1-fjL3W0E4EpHQRhHxvxQQmsAGUdc=
 
 qs@~6.5.2:
-  version "6.5.2"
-  resolved "https://registry.yarnpkg.com/qs/-/qs-6.5.2.tgz#cb3ae806e8740444584ef154ce8ee98d403f3e36"
-  integrity sha512-N5ZAX4/LxJmF+7wN74pUD6qAh9/wnvdQcjq9TZjevvXzSUo7bfmw91saqMjzGS2xq91/odN2dW/WOl7qQHNDGA==
+  version "6.5.3"
+  resolved "https://registry.yarnpkg.com/qs/-/qs-6.5.3.tgz#3aeeffc91967ef6e35c0e488ef46fb296ab76aad"
+  integrity sha512-qxXIEh4pCGfHICj1mAJQ2/2XVZkjCDTcEgfoSQxc/fYivUZxTkk7L3bDBJSoNrEzXI17oUO5Dp07ktqE5KzczA==
 
 querystring-es3@^0.2.0:
   version "0.2.1"

src/indexes.ts

@@ -44,7 +44,7 @@ import { HttpRequests } from './http-requests'
 import { Task, TaskClient } from './task'
 import { EnqueuedTask } from './enqueued-task'
 
-class Index<T = Record<string, any>> {
+class Index<T extends Record<string, any> = Record<string, any>> {
   uid: string
   primaryKey: string | undefined
   createdAt: Date | undefined
@@ -76,11 +76,11 @@ class Index<T = Record<string, any>> {
    * @param config - Additional request configuration options
    * @returns Promise containing the search response
    */
-  async search<T = Record<string, any>>(
+  async search<D = T>(
     query?: string | null,
     options?: SearchParams,
     config?: Partial<Request>
-  ): Promise<SearchResponse<T>> {
+  ): Promise<SearchResponse<D>> {
     const url = `indexes/${this.uid}/search`
 
     return await this.httpRequest.post(
@@ -99,11 +99,11 @@ class Index<T = Record<string, any>> {
    * @param config - Additional request configuration options
    * @returns Promise containing the search response
    */
-  async searchGet<T = Record<string, any>>(
+  async searchGet<D = T>(
     query?: string | null,
     options?: SearchParams,
     config?: Partial<Request>
-  ): Promise<SearchResponse<T>> {
+  ): Promise<SearchResponse<D>> {
     const url = `indexes/${this.uid}/search`
 
     const parseFilter = (filter?: Filter): string | undefined => {
@@ -126,7 +126,7 @@ class Index<T = Record<string, any>> {
       attributesToHighlight: options?.attributesToHighlight?.join(','),
     }
 
-    return await this.httpRequest.get<SearchResponse<T>>(
+    return await this.httpRequest.get<SearchResponse<D>>(
       url,
       removeUndefinedFromObject(getParams),
       config

tests/env/typescript-node/src/index.ts

@@ -19,6 +19,9 @@ interface Movie {
   id: number
   title: string
   genre?: string
+  comment?: string
+  isNull?: null
+  isTrue?: true
 }
 
 const client = new MeiliSearch(config)

tests/typed_search.test.ts

@@ -21,6 +21,8 @@ interface Movie {
   title: string
   comment?: string
   genre?: string
+  isNull?: null
+  isTrue?: boolean
 }
 
 interface NestedDocument {

yarn.lock

@@ -1552,10 +1552,10 @@
     "@babel/helper-module-imports" "^7.18.6"
     "@rollup/pluginutils" "^5.0.1"
 
-"@rollup/[email protected].3":
-  version "23.0.3"
-  resolved "https://registry.yarnpkg.com/@rollup/plugin-commonjs/-/plugin-commonjs-23.0.3.tgz#442cd8ccca1b7563a503da86fc84a1a7112b54bb"
-  integrity sha512-31HxrT5emGfTyIfAs1lDQHj6EfYxTXcwtX5pIIhq+B/xZBNIqQ179d/CkYxlpYmFCxT78AeU4M8aL8Iv/IBxFA==
+"@rollup/[email protected].4":
+  version "23.0.4"
+  resolved "https://registry.yarnpkg.com/@rollup/plugin-commonjs/-/plugin-commonjs-23.0.4.tgz#854e9b1a83f0a715ded70a2ae411bebc11141de2"
+  integrity sha512-bOPJeTZg56D2MCm+TT4psP8e8Jmf1Jsi7pFUMl8BN5kOADNzofNHe47+84WVCt7D095xPghC235/YKuNDEhczg==
   dependencies:
     "@rollup/pluginutils" "^5.0.1"
     commondir "^1.0.1"