2024/08/14 にAlgolia API clients のメジャーアップデートがありました。
New major versions of all Algolia API clients
All Algolia API clients have new major releases. We updated the API references to show code snippets in the new versions. For more information, see API clients, or check the new API reference, for example, for the Search API.
この記事を書いている時点での JavaScript client の最新バージョンは 5.1.1 です。
新しいものはすぐ使ってみたいので、じゃあ移行するか！と思ったのですが、現段階でドキュメントがこれしかないです。
最初見た時「えっ、これで終わり！？」と声に出してしまったのですが、本当にこれしかないです。各ライブラリとメソッドのドキュメントがほぼ丸々存在しません。これで移行させるのはユーザーの技術力を過信しすぎています。なお、 Upgrade the JavaScript API clients to v5 に至っては派手に間違っている箇所があり、そのまま写経しても動きません。（Pull Requestを送るところがなさそうだったので、代わりにフィードバックを送っておきました。2024/09/02に修正されました。）
私は TypeScript を使っているのですが、型の情報もありません。もともと v4 の段階で TypeScript のドキュメントは存在していなかったのですが、今回は JavaScript の時点でドキュメントに情報がなさすぎるため、 TypeScript で移行するには相当に厳しいです。
とりあえず GitHub を見てみたら他の人も移行できてなくて安心しました。やっぱ無理があるよなぁ…。
Request Options のパラメーターの類は REST API と一緒だからそっちのドキュメントを読んでくれっていう話なんですね。
Heya @MattIPv4 -- the new clients are a fundamental shift to move the SDKs closer to the REST API.
— Algolia (@algolia) August 20, 2024
As part of this, most of the code samples now reside directly in the REST API docs.https://t.co/iTqXXSdhk2
ただ、REST APIのドキュメントも不完全で、ドキュメントにない（コードサンプルにしかない）オプションがあるので、実際のところソースコードを読まないと移行は難しそうです。読んだところで型の指定がうまくいかなさそうですが…。
あまりに情報がなさすぎて厳しいのと、v4 で十分満足していることもあり、現時点での v4 -> v5 移行は断念しました。
急いでアップデートしなくても問題ないとのことなので、1年ぐらい v4 のまま放置すると思います。