Improve TaskClient, BatchClient and associated types

[flevi29]

Pull Request

What does this PR do?

• remove classes Batch, EnqueuedTask and Task
  • these had no other functionality other than to re-create their *Object equivalent objects, that come from the API responses, for the most part with the same exact properties and values
  • some of them converted date strings to Date objects, but this functionality is also being removed, because:
    • most users don't use these properties, so for them it's just extra useless processing
    • maybe users want to use a different date object, like the upcoming Temporal API, or Luxon or any other
• improve, fix, adjust and document types, with the help of meilisearch Rust source code
  • rename type EnqueuedTaskObject to EnqueuedTask
    • remove canceledBy property as it doesn't exist
    • indexUid property cannot be undefined but can be null
  • rename type BatchObject to Batch, adjust properties
  • rename type TaskObject to Task, adjust properties
    • for instance Task.details had quite a few properties missing, like pagination, now it's reusing the Settings type, so we don't repeat ourselves
• rework and document TaskClient
  • refactor waitForTask, now it uses setTimeout for timeout instead of inaccurate expensive date calculations
  • can now accept task uid number or an EnqueuedTask object as parameter
  • waitForTasks can now accept an iterable or an asynchronous iterable instead of just an array as parameter
  • new method waitForTasksIter, which is an asynchronous generator, that lazily awaits the tasks
• every method that returned a Promise<EnqueuedTask> now instead returns an EnqueuedTaskPromise
  • this is a Promise<EnqueuedTask> with an extra method waitTask, that first gets the EnqueuedTask and then internally calls TaskClient.waitForTask on it to return a Promise<Task>, avoiding quite a bit of boilerplate
• new property on Config: defaultWaitOptions - used to set the default wait options for TaskClient
• reduce interval for waiting tasks in tests, thus making tests complete often in under 2 minutes
• waiting on Remove hint about bad Meilisearch version #1848

Caution

• TaskClient is no longer exported, use it through Meilisearch or Index instead, on both available as tasks property
  • this brings it in line with BatchClient which isn't exported in the index file
• Batch class is only a type now
• EnqueuedTask class is only a type now
• Task class is only a type now
• any property on the 3 items above that was a Date before is now a string
  • conversion to Date is left to the user (new Date(str))

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!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.71%. Comparing base (698f7e9) to head (3156692).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1825      +/-   ##
==========================================
- Coverage   98.84%   98.71%   -0.14%     
==========================================
  Files          17       17              
  Lines        1565     1400     -165     
  Branches      338      291      -47     
==========================================
- Hits         1547     1382     -165     
  Misses         18       18              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[flevi29]

For some reason it's a lot slower, whereas it should be faster. I'll investigate.

[flevi29]

Okay, solved the slowness problem.

Next, there's a lot of apply wait task. Should probably integrate it with http requests instead.