Add changes from #1943

Author: flevi29

.code-samples.meilisearch.yaml

@@ -99,35 +99,35 @@ multi_search_1: |-
     },
   ]})
 get_all_tasks_1: |-
-  client.getTasks()
+  client.tasks.getTasks()
 get_task_1: |-
-  client.getTask(1)
+  client.tasks.getTask(1)
 async_guide_filter_by_date_1: |-
-  client.getTasks({ afterEnqueuedAt: '2020-10-11T11:49:53.000Z' })
+  client.tasks.getTasks({ afterEnqueuedAt: '2020-10-11T11:49:53.000Z' })
 async_guide_multiple_filters_1: |-
-  client.getTasks({
+  client.tasks.getTasks({
     indexUids: ['movies'],
     types: ['documentAdditionOrUpdate','documentDeletion'],
     statuses: ['processing']
   })
 async_guide_filter_by_ids_1: |-
-  client.getTasks({ uids: [5, 10, 13] })
+  client.tasks.getTasks({ uids: [5, 10, 13] })
 async_guide_filter_by_statuses_1: |-
-  client.getTasks({ statuses: ['failed', 'canceled'] })
+  client.tasks.getTasks({ statuses: ['failed', 'canceled'] })
 async_guide_filter_by_types_1: |-
-  client.getTasks({ types: ['dumpCreation', 'indexSwap'] })
+  client.tasks.getTasks({ types: ['dumpCreation', 'indexSwap'] })
 async_guide_filter_by_index_uids_1: |-
-  client.getTasks({ indexUids: ['movies'] })
+  client.tasks.getTasks({ indexUids: ['movies'] })
 get_all_tasks_paginating_1: |-
-  client.getTasks({ limit: 2, from: 10 })
+  client.tasks.getTasks({ limit: 2, from: 10 })
 get_all_tasks_paginating_2: |-
-  client.getTasks({ limit: 2, from: 8 })
+  client.tasks.getTasks({ limit: 2, from: 8 })
 async_guide_canceled_by_1: |-
-  client.getTasks({ canceledBy: [9, 15] })
+  client.tasks.getTasks({ canceledBy: [9, 15] })
 delete_tasks_1: |-
-  client.deleteTasks({ uids: [1, 2] })
+  client.tasks.deleteTasks({ uids: [1, 2] })
 cancel_tasks_1: |-
-  client.cancelTasks({ uids: [1, 2] })
+  client.tasks.cancelTasks({ uids: [1, 2] })
 get_one_key_1: |-
   client.getKey('6062abda-a5aa-4414-ac91-ecd7944c0f8d')
 get_all_keys_1: |-
@@ -458,7 +458,7 @@ getting_started_update_searchable_attributes: |-
 getting_started_update_stop_words: |-
   client.index('movies').updateStopWords(['the'])
 getting_started_check_task_status: |-
-  client.getTask(0)
+  client.tasks.getTask(0)
 getting_started_synonyms: |-
   client.index('movies').updateSynonyms({
     winnie: ['piglet'],
@@ -806,9 +806,9 @@ update_prefix_search_settings_1: |-
 reset_prefix_search_settings_1: |-
   client.index('INDEX_NAME').resetPrefixSearch();
 get_all_batches_1: |-
-  client.getBatches();
+  client.batches.getBatches();
 get_batch_1: |-
-  client.getBatch(BATCH_UID);
+  client.batches.getBatch(BATCH_UID);
 # Vector search
 update_embedders_1: |-
   client.index('INDEX_NAME').updateEmbedders({

README.md

@@ -531,37 +531,37 @@ client.index('myIndex').deleteAllDocuments(): Promise<Types.EnqueuedTask>
 #### [Get all tasks](https://www.meilisearch.com/docs/reference/api/tasks#get-all-tasks)
 
 ```ts
-client.getTasks(parameters: TasksQuery): Promise<TasksResults>
+client.tasks.getTasks(parameters: TasksQuery): Promise<TasksResults>
 ```
 
 #### [Get one task](https://www.meilisearch.com/docs/reference/api/tasks)
 
 ```ts
-client.getTask(uid: number): Promise<Task>
+client.tasks.getTask(uid: number): Promise<Task>
 ```
 
 #### [Delete tasks](https://www.meilisearch.com/docs/reference/api/tasks#delete-tasks)
 
 ```ts
-client.deleteTasks(parameters: DeleteTasksQuery = {}): Promise<EnqueuedTask>
+client.tasks.deleteTasks(parameters: DeleteTasksQuery = {}): Promise<EnqueuedTask>
 ```
 
 #### [Cancel tasks](https://www.meilisearch.com/docs/reference/api/tasks#cancel-tasks)
 
 ```ts
-client.cancelTasks(parameters: CancelTasksQuery = {}): Promise<EnqueuedTask>
+client.tasks.cancelTasks(parameters: CancelTasksQuery = {}): Promise<EnqueuedTask>
 ```
 
 #### [Get all tasks of an index](https://www.meilisearch.com/docs/reference/api/tasks#get-all-tasks-by-index)
 
 ```ts
-client.index('myIndex').getTasks(parameters: TasksQuery): Promise<TasksResults>
+client.index('myIndex').tasks.getTasks(parameters: TasksQuery): Promise<TasksResults>
 ```
 
 #### [Get one task of an index](https://www.meilisearch.com/docs/reference/api/tasks)
 
 ```ts
-client.index('myIndex').getTask(uid: number): Promise<Task>
+client.index('myIndex').tasks.getTask(uid: number): Promise<Task>
 ```
 
 #### Wait for one task
@@ -581,13 +581,13 @@ client.tasks.waitForTasks(uids: number[], { timeout?: number, interval?: number
 #### [Get one batch](https://www.meilisearch.com/docs/reference/api/batches#get-one-batch)
 
 ```ts
-client.getBatch(uid: number): Promise<Batch>
+client.batches.getBatch(uid: number): Promise<Batch>
 ```
 
 #### [Get all batches](https://www.meilisearch.com/docs/reference/api/batchess#get-batches)
 
 ```ts
-client.getBatches(parameters: BatchesQuery = {}): Promise<BatchesResults>
+client.batches.getBatches(parameters: BatchesQuery = {}): Promise<BatchesResults>
 ```
 
 ### Indexes <!-- omit in toc -->

src/batch.ts

@@ -19,20 +19,11 @@ export class BatchClient {
 
   /** {@link https://www.meilisearch.com/docs/reference/api/batches#get-one-batch} */
   async getBatch(uid: number): Promise<Batch> {
-    const batch = await this.#httpRequest.get<Batch>({
-      path: `batches/${uid}`,
-    });
-    return batch;
+    return await this.#httpRequest.get({ path: `batches/${uid}` });
   }
 
   /** {@link https://www.meilisearch.com/docs/reference/api/batches#get-batches} */
-  async getBatches(
-    batchesQuery?: TasksOrBatchesQuery,
-  ): Promise<BatchesResults> {
-    const batches = await this.#httpRequest.get<BatchesResults>({
-      path: "batches",
-      params: batchesQuery,
-    });
-    return batches;
+  async getBatches(params?: TasksOrBatchesQuery): Promise<BatchesResults> {
+    return await this.#httpRequest.get({ path: "batches", params });
   }
 }

src/task.ts

@@ -74,24 +74,20 @@ export class TaskClient {
     // TODO: Need to do this for all other methods: https://github.com/meilisearch/meilisearch-js/issues/1476
     extraRequestInit?: ExtraRequestInit,
   ): Promise<Task> {
-    const task = await this.#httpRequest.get<Task>({
+    return await this.#httpRequest.get({
       path: `tasks/${uid}`,
       extraRequestInit,
     });
-    return task;
   }
 
   /** {@link https://www.meilisearch.com/docs/reference/api/tasks#get-tasks} */
   async getTasks(params?: TasksOrBatchesQuery): Promise<TasksResults> {
-    const tasks = await this.#httpRequest.get<TasksResults>({
-      path: "tasks",
-      params,
-    });
-    return tasks;
+    return await this.#httpRequest.get({ path: "tasks", params });
   }
 
   /**
-   * Wait for an enqueued task to be processed.
+   * Wait for an enqueued task to be processed. This is done through polling
+   * with {@link TaskClient.getTask}.
    *
    * @remarks
    * If an {@link EnqueuedTask} needs to be awaited instantly, it is recommended
@@ -167,20 +163,14 @@ export class TaskClient {
   /** {@link https://www.meilisearch.com/docs/reference/api/tasks#cancel-tasks} */
   cancelTasks(params: DeleteOrCancelTasksQuery): EnqueuedTaskPromise {
     return this.#applyWaitTask(
-      this.#httpRequest.post({
-        path: "tasks/cancel",
-        params,
-      }),
+      this.#httpRequest.post({ path: "tasks/cancel", params }),
     );
   }
 
   /** {@link https://www.meilisearch.com/docs/reference/api/tasks#delete-tasks} */
   deleteTasks(params: DeleteOrCancelTasksQuery): EnqueuedTaskPromise {
     return this.#applyWaitTask(
-      this.#httpRequest.delete({
-        path: "tasks",
-        params,
-      }),
+      this.#httpRequest.delete({ path: "tasks", params }),
     );
   }
 }

src/types/shared.ts

@@ -16,3 +16,12 @@ export type NonNullableDeepRecordValues<T> = {
       ? NonNullableDeepRecordValues<T[P]>
       : NonNullable<T[P]>;
 };
+
+// taken from https://stackoverflow.com/a/65642944
+export type PascalToCamelCase<S extends string> = Uncapitalize<S>;
+
+export type SafeOmit<T, K extends keyof T> = Omit<T, K>;
+
+export type OptionStarOr<T> = "*" | T | null;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type OptionStarOrList<T extends any[]> = ["*"] | T | null;