Separate token specific code into its own export

[flevi29]

Pull Request

Related issue

Fixes #1690

What does this PR do?

• generalizes the MeiliSearch client into a single universal export by stripping Node.js crypto specific token code into its own separate exported module
• apiKey option is now mandatory in generateTenantToken function

Migration

Old:

import { MeiliSearch } from "meilisearch";

const client = new MeiliSearch({ host: "http://127.0.0.1:7700", apiKey: "masterKey" });
const token = await client.generateTenantToken("e489fe16-3381-431b-bee3-00430192915d");

// ...

New:

import { generateTenantToken } from "meilisearch/token";

const token = await generateTenantToken("e489fe16-3381-431b-bee3-00430192915d", [], { apiKey: "masterKey" });

// ...

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 97.81%. Comparing base (e224f5c) to head (834fd67).
Report is 11 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1739      +/-   ##
==========================================
+ Coverage   97.55%   97.81%   +0.26%     
==========================================
  Files          20       17       -3     
  Lines        1513     1465      -48     
  Branches      319      307      -12     
==========================================
- Hits         1476     1433      -43     
+ Misses         37       32       -5     

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

[brunoocasali]

What will happen if I try to use it on the web? It will just not even compile or what?

[brunoocasali]

By the way do you know if this could solve the issue: meilisearch/meilisearch-js-plugins#1330 ?

[flevi29]

By the way do you know if this could solve the issue: meilisearch/meilisearch-js-plugins#1330 ?

@brunoocasali It should solve it, because they would no longer be importing any file associated with node:crypto when they are importing from "meilisearch". For this error to occur they would have to import from "meilisearch/token" with these changes.

What will happen if I try to use it on the web? It will just not even compile or what?

It will err, because there is no such thing as "node:crypto" to import from on the web. Same way as it would currently if we didn't strip it in the browser client. Although users can still polyfill it to some extent, possibly entirely. Parcel will automatically try to polyfill it with crypto-browserify (even though it's extremely outdated) for instance.
https://parceljs.org/features/node-emulation/#polyfilling-%26-excluding-builtin-node-modules
https://www.npmjs.com/package/crypto-browserify

[brunoocasali]

LGTM!

Can you mention in the transition path tutorial about the requirement of the apiKey (in a clear example)

[brunoocasali]

@flevi29 I would just wait to merge this after the next release. Unless we merge this and create a new release before the main one, wtdyt?

[flevi29]

Okay, we can wait.

[flevi29]

bors merge

[meili-bors]

Build succeeded:

• integration-tests (Node.js 18)
• integration-tests (Node.js 20)
• style-check
• types-check