Bump meilisearch to v0.57.0

[Strift]

Pull Request

Why

Bump meilisearch to v0.57 and align dependencies requirements

What does this PR do?

• Bump meilisearch dependency to v0.57.0
• Mark MeiliSearch* exports (with capital S) as deprecated; export the lowercase replacements
• Update README to document Node.js v20+ requirement

Migration guide

The following types are now deprecated and will be removed in the future minor release:

• MeiliSearch, use Meilisearch instead (lowercase 's')
• MeiliSearchMultiSearchParams, use MeilisearchMultiSearchParams (lowercase 's')

AI disclosure

Cursor with gpt-5.4-medium, gpt-5.1-high, composer-2, and codex-5.3-spark.

PR checklist

Please check if your PR fulfills the following requirements:

• Did you use any AI tool while implementing this PR (code, tests, docs, etc.)? If yes, disclose it in the PR description and describe what it was used for. AI usage is allowed when it is disclosed.
• 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!

Summary by CodeRabbit

• Chores

  • Updated minimum Node.js runtime requirement to v20.19.0 (or v22.12.0+)
  • Updated Meilisearch client dependency to v0.57.0
  • Adjusted build config to include/bundle the Meilisearch library

• Documentation

  • Updated supported Node.js and NPM (>=10.x) requirements across docs and READMEs
  • Added an nvm use step to the CONTRIBUTING setup instructions
  • Removed some framework integration links from a README

[changeset-bot]

🦋 Changeset detected

Latest commit: 2380b4e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@meilisearch/autocomplete-client	Patch
@meilisearch/instant-meilisearch	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

• ▶️ Resume reviews
• 🔍 Trigger review

📝 Walkthrough

Walkthrough

Updates Node.js requirement to v20.19.0+, adds engines.node constraints, upgrades meilisearch to v0.57.0 and migrates code/tests/types from the renamed export MeiliSearch → Meilisearch, adding type aliases for backward compatibility and small docs/setup/build adjustments.

Changes

Cohort / File(s)	Summary
Node.js Environment Updates /.nvmrc, tsconfig.json, CONTRIBUTING.md	Bumped Node version to v20.19.0, added nvm use in setup, and updated an inline TS comment about target/runtime.
Top-level & Package Config package.json, packages/instant-meilisearch/package.json, packages/autocomplete-client/README.md, packages/instant-meilisearch/README.md	Added `engines.node: ^20.19.0
Type export & aliases packages/instant-meilisearch/src/types/types.ts	Introduced canonical aliases Meilisearch, MeilisearchMultiSearchParams and deprecated aliases MeiliSearch, MeiliSearchMultiSearchParams; rewired exported type usages.
Type references across code packages/instant-meilisearch/src/adapter/.../search-params-adapter.ts, packages/instant-meilisearch/src/adapter/.../search-resolver.ts, packages/instant-meilisearch/src/cache/init-facets-distribution.ts	Replaced type usages MeiliSearch* → Meilisearch* in function signatures, return types, and parameters.
Client instantiation & runtime usage packages/instant-meilisearch/src/client/instant-meilisearch-client.ts, playgrounds/local-react/setup.mjs, playgrounds/node-env/index.js, playgrounds/autocomplete/setup.mjs	Updated runtime construction to use new meilisearch.Meilisearch(...) (rename of exported constructor); no behavioral changes.
Tests & test utils packages/autocomplete-client/__tests__/test.utils.ts, packages/instant-meilisearch/__tests__/assets/utils.ts, packages/instant-meilisearch/__tests__/search-resolver.test.ts	Adjusted imports, constructor usage, type annotations, and mock assertions to the renamed Meilisearch symbols.
Build config & metadata packages/instant-meilisearch/vite.config.ts, .changeset/all-forks-allow.md	Removed meilisearch from Rollup externals (UMD bundle change); added changeset noting export removal.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰
A name reborn, a client hops anew,
From cap to small, the export changed its hue.
Node climbs higher, twenty-point-nineteen bright,
Aliases hold the old ways soft and light.
A nimble rabbit cheers the tidy bite.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 71.43% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The PR title describes the main dependency update to meilisearch v0.57.0, which is the primary package version change, but understates the scope of the PR which also involves significant API naming changes and Node.js version constraints.
Linked Issues check	✅ Passed	The PR successfully addresses issue #1468 by updating meilisearch to v0.57.0, updating all type references from MeiliSearch to Meilisearch, and providing deprecated aliases for backward compatibility.
Out of Scope Changes check	✅ Passed	All changes are directly related to the meilisearch v0.57.0 upgrade and compatibility fix, including Node.js version constraints and documentation updates; no out-of-scope changes detected.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch chore/update-dependencies

---

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 and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

packages/instant-meilisearch/src/types/types.ts (1)

36-37: Remove the non-essential alias comment on Line 36.

Meilisearch is already self-descriptive; dropping this explanatory comment would better match the repo’s comment style preference.

As per coding guidelines, "Prefer self-descriptive code to comments. Only use comments for complex logic."

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@packages/instant-meilisearch/src/types/types.ts` around lines 36 - 37, Remove
the non-essential comment above the type alias by deleting the line that reads
"/* The Meilisearch client class type (instance shape). */" so only the
self-descriptive type alias export type Meilisearch = MeilisearchClient remains;
locate the declaration of the Meilisearch type alias (symbol: Meilisearch) and
remove the explanatory comment while leaving the alias and MeilisearchClient
reference intact.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@packages/instant-meilisearch/src/types/types.ts`:
- Around line 36-37: Remove the non-essential comment above the type alias by
deleting the line that reads "/* The Meilisearch client class type (instance
shape). */" so only the self-descriptive type alias export type Meilisearch =
MeilisearchClient remains; locate the declaration of the Meilisearch type alias
(symbol: Meilisearch) and remove the explanatory comment while leaving the alias
and MeilisearchClient reference intact.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 87705952-1b11-423c-af5b-e6d550af59bd

📥 Commits

Reviewing files that changed from the base of the PR and between f1bdb92 and 2952250.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (21)

• .github/actions/set-up-node/action.yml
• .nvmrc
• CONTRIBUTING.md
• package.json
• packages/autocomplete-client/README.md
• packages/autocomplete-client/__tests__/test.utils.ts
• packages/autocomplete-client/package.json
• packages/instant-meilisearch/README.md
• packages/instant-meilisearch/__tests__/assets/utils.ts
• packages/instant-meilisearch/__tests__/search-resolver.test.ts
• packages/instant-meilisearch/package.json
• packages/instant-meilisearch/src/adapter/search-request-adapter/search-params-adapter.ts
• packages/instant-meilisearch/src/adapter/search-request-adapter/search-resolver.ts
• packages/instant-meilisearch/src/cache/init-facets-distribution.ts
• packages/instant-meilisearch/src/client/instant-meilisearch-client.ts
• packages/instant-meilisearch/src/types/types.ts
• packages/instant-meilisearch/vite.config.ts
• playgrounds/autocomplete/setup.mjs
• playgrounds/local-react/setup.mjs
• playgrounds/node-env/index.js
• tsconfig.json

[flevi29]

Hmm, the meilisearch global will no longer work if anyone used it like that (although I doubt many did). Wouldn't it be better if we made the same changes here as well? And show users how to import the ESM version in HTML scripts? I can make a separate PR if you want me to.

[Strift]

@flevi29, I agree, we can move to ESM here, too.

I changed this to a minor version update because the UMD changes are breaking due to our removal of the global export.

[flevi29]

@Strift #1471 sets meilisearch as a peer dependency, this means that the lowest working version is required by the plugin, but ultimately the user has to install it (some package managers do it automatically otherwise). So I guess that part of this PR is superseded.

[Strift]

Hey @flevi29, I reworked the PR after rebasing off your work; let me know if this looks good 🙏