feat(index): add compact() method for index compaction

[mixelburg]

Summary

Adds support for the index compaction API introduced in Meilisearch v1.23 (reference).

Changes

• Added compact() method to the Index class — calls POST /indexes/{indexUid}/compact
• Added tests/compact.test.ts with permission, auth denial, and URL construction test cases
• Added compact_index_1 code sample to .code-samples.meilisearch.yaml

Usage

// Trigger compaction and wait for it to complete
const task = await client.index('movies').compact().waitTask();
console.log(task.status); // 'succeeded'

Closes

Closes #2066

Summary by CodeRabbit

• New Features
  • Added an API to compact indexes, helping optimize storage and improve performance.
• Documentation
  • Included an additional code sample showing how to run index compaction.
• Tests
  • Added end-to-end tests for index compaction, including permission handling (success and failure), error propagation, and host/URL construction behavior.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: aedd6773-8255-4371-8247-b96a459abe73

📥 Commits

Reviewing files that changed from the base of the PR and between f656c8e and e26a0a8.

📒 Files selected for processing (2)

• .code-samples.meilisearch.yaml
• src/indexes.ts

🚧 Files skipped from review as they are similar to previous changes (2)

• src/indexes.ts
• .code-samples.meilisearch.yaml

---

📝 Walkthrough

Walkthrough

Adds Index.compact() to enqueue index compaction, plus a matching code sample and end-to-end tests for access control and request routing.

Changes

Index compaction support

Layer / File(s)	Summary
Compaction API, sample, and tests src/indexes.ts, .code-samples.meilisearch.yaml, tests/compact.test.ts	Adds Index.compact() as a POST to indexes/{uid}/compact, includes a client.index('movies').compact() sample, and adds E2E coverage for success, auth failures, and host/URL handling.

Sequence Diagram(s)

sequenceDiagram
    autonumber
    participant Client
    participant Index
    participant HTTP
    participant MeiliSearch
    Client->>Index: client.index('movies').compact()
    Index->>HTTP: POST /indexes/movies/compact
    HTTP->>MeiliSearch: authenticated request
    MeiliSearch-->>HTTP: enqueued task response
    HTTP-->>Index: EnqueuedTaskPromise
    Index-->>Client: return promise

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hop to compact, neat and bright,
One tiny call makes indexes right.
Keys and hosts all take their test,
A little task, a tidy nest.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title is concise and accurately describes the new compact() API for index compaction.
Linked Issues check	✅ Passed	The PR adds the compact endpoint method, matching tests, and the required code sample for issue #2066.
Out of Scope Changes check	✅ Passed	The changes stay within the compact API scope and do not introduce unrelated functionality.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[mixelburg]

Closing due to inactivity. Over 3 months with no review. Happy to reopen if the team is interested.

[Strift]

Apologies for the delay; this slipped through the cracks!

[Strift]

Thanks for your PR, but the CI is not passing. I suggest running linter + formatter + tests locally before requesting another review 🙏