Improve indexes

[flevi29]

Pull Request

What does this PR do?

• refactors index types so that they match the meilisearch rust source code model as much as possible
• removes index manipulating methods from Index class that don't directly take an index UID parameter, and vice versa for MeiliSearch class
• removes methods that query and then create Index instances from queried data
• removes deleteIndexIfExists, this is a flawed function that is no longer required, because the base delete function doesn't throw if the index doesn't exist, so it has the same effect
• refactors tests for these methods
  • test were unnecessarily lengthy and were covering things that were either
    • already covered by other tests
    • already covered by tests in the same file, but with different variations to parameters (we're not testing meilisearch here, we just want to make sure that most of our input is accepted and the expected response is returned)
    • straight up unnecessary, like testing for each endpoint whether a wrong host will give a certain error, these types of tests are HttpRequests tests, and even so might be overdoing things

Migration

• fn getRawIndex -> getIndex
• type IndexObject -> IndexView
• fn getRawIndexes -> getIndexes
• type IndexesResults<IndexObject[]> -> IndexViewList
• type IndexesQuery -> ListIndexes
• type IndexOptions -> IndexCreateRequest

- await client.deleteIndexIfExists(uid);
+ const task = await client.index(uid).deleteIndex().waitTask();
+ const indexNotExists = task.error?.code === "index_not_found";

- await client.deleteIndex(uid).waitTask();
- await client.index(uid).delete().waitTask();
+ await client.index(uid).deleteIndex().waitTask();

- await client.updateIndex(...).waitTask();
- await client.index(uid).update(...).waitTask();
+ await client.index(uid).updateIndex(...).waitTask();

- await client.getRawIndex(uid);
- await client.index(uid).getRawInfo();
+ await client.index(uid).getIndex();

- await client.createIndex(uid, { primaryKey }).waitTask();
+ await client.createIndex({ uid, primaryKey }).waitTask();

These are hardly useful, but here's the migration anyway:

- const index = await client.getIndex(uid);
+ const index = client.index(uid);
+ const obj = { details: await index.getIndex(), index };

- const indexes = await client.getIndexes();
+ const indexes = (await client.getIndexes()).results.map((v) => ({
+   details: v,
+   index: client.index(v.uid),
+ }));

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 99.92%. Comparing base (7da269f) to head (6189297).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1918      +/-   ##
==========================================
+ Coverage   99.02%   99.92%   +0.90%     
==========================================
  Files          18       18              
  Lines        1435     1368      -67     
  Branches      303      292      -11     
==========================================
- Hits         1421     1367      -54     
+ Misses         14        1      -13     

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.