Improve various types

[flevi29]

Pull Request

What does this PR do?

• improved and/or documented various types and methods

Migration

• type Health -> HealthResponse
• type Version -> VersionResponse

- import { ErrorStatusCode } from "meilisearch";
- ErrorStatusCode.INVALID_API_KEY;
+ import type { Code } from "meilisearch";
+ const myErrorCode: Code = "invalid_api_key";

[codecov]

Codecov Report

Attention: Patch coverage is 94.11765% with 1 line in your changes missing coverage. Please review.

Project coverage is 99.15%. Comparing base (e11dfdb) to head (cc59dee).

Files with missing lines	Patch %	Lines
src/meilisearch.ts	87.50%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1919      +/-   ##
==========================================
+ Coverage   99.02%   99.15%   +0.13%     
==========================================
  Files          18       18              
  Lines        1435     1301     -134     
  Branches      303      303              
==========================================
- Hits         1421     1290     -131     
+ Misses         14       11       -3     

☔ 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.

[Copilot]

Pull Request Overview

This PR improves and documents various types and methods, with a focus on renaming types (e.g. Health to HealthResponse and Version to VersionResponse) and replacing inline error code references with string literals.

• Migrates error codes from ErrorStatusCode enums to inline string literals for improved type safety and clarity
• Updates documentation comments in source files and refines type definitions
• Adjusts tests accordingly to match the new error code format

Reviewed Changes

Copilot reviewed 38 out of 38 changed files in this pull request and generated no comments.

File	Description
tests/*	Replaces ErrorStatusCode with explicit string literals
src/types/* and src/errors/*	Updates type names and documentation per migration requirements
src/meilisearch.ts and src/indexes.ts	Migrates API responses and error handling to new type definitions

Comments suppressed due to low confidence (2)

tests/get_search.test.ts:551

• [nitpick] Consider centralizing error code string literals into a shared constant or module rather than using inline strings throughout tests. This can help reduce duplication, avoid potential typos, and simplify future updates.

).rejects.toHaveProperty("cause.code", "index_not_found");

src/meilisearch.ts:187

• [nitpick] Consider centralizing the error code string literals (e.g., "index_not_found") into a dedicated constants module to ensure consistency and maintainability across both production and test code.

if ((e as MeiliSearchApiError)?.cause?.code === "index_not_found") {