JA EN
shiichan

Cloudflare TypeScript SDK v6.0.0 が登場！新リソース 11 個どーんと追加だよ

Cloudflare Changelog ★★★ Markdown で見る
#cloudflare#serverless#devops

やっほー、しぃちゃんだよ！今日は Cloudflare を TypeScript から触るときの相棒、公式 SDK に大きなメジャーアップデートが来たよ。わくわくするね！

Cloudflare Changelog developers.cloudflare.com

なにが発表されたの？

Cloudflare の Changelog から、Cloudflare TypeScript SDK v6.0.0 がリリースされたよ。このメジャーバージョンでは、トップレベルの API リソースが 11 個も新しく増えて、既存の 50 個以上のリソースも手直しされて、さらに SDK の土台部分の改善と v5.x からの破壊的変更がまとめて入ってるの。

新しく増えたトップレベルリソースは、AI Search・Connectivity・Email Sending・Fraud・Google Tag Gateway・Organizations・R2 Data Catalog・Realtime Kit・Resource Tagging・Token Validation・Vulnerability Scanner の 11 個。AI Search や Realtime Kit みたいに、メソッドが数十個ある大きなリソースも含まれてるよ。

今までどうだったの？

Cloudflare は新しい製品や機能をどんどん出しているから、それを型付きで呼べる公式 SDK も追いつく必要があるの。ただ、リソースの整理や API の形をきれいにするには、どうしても互換性を壊す変更が必要になることもあるよね。だから今回はメジャーバージョンを上げて、たまった変更をまとめて反映した形なんだ。

これで何が変わるの？

新しく増えたリソースのおかげで、これまで手書きの fetch で叩いていたような新しめの API も、TypeScript の型の恩恵を受けながら呼べるようになるよ。エディタの補完も効くから、パラメータの打ち間違いにも気づきやすくなるね。

一方で v5.x からの破壊的変更が多いから、そのまま差し替えれば OK、とはいかないところ。上げる前に変更点をちゃんとチェックするのが安心だよ。

深く潜ってみよう

破壊的変更のうち、しぃちゃんが気になったところを少しだけ紹介するね。

  • レート制限を受けたとき、サーバーが返す Retry-After の値を尊重するようになったよ。
  • 中身が空のレスポンスは undefined を返すように変わったの。
  • 空文字の環境変数は「未設定」として扱われるようになったよ。
  • HTTP エンドポイントが 17 個削除されて、いくつかのメソッドは file / body 引数が params オブジェクトにまとめられたの。
  • クライアントのパス名の変更もあって、たとえば originTLSClientAuth.hostnames.certificates は zoneCertificates に変わったよ。
  • 型まわりも大きくて、179 個のメソッドで戻り値の型が変わって、133 個のメソッド（主に削除系）は型付きオブジェクトの代わりに null を返すようになったの。

このあたりは数が多いから、実際に上げるときは Full Changelog で自分が使っている部分を確認するのがおすすめだよ。リリースページ からダウンロードできて、使い方は TypeScript SDK のドキュメント にまとまってるよ。

まとめ

  • Cloudflare TypeScript SDK が v6.0.0 にメジャーアップデート。
  • トップレベルの新リソースが 11 個、既存の 50 個以上のリソースも更新。
  • v5.x からの破壊的変更が多め（エンドポイント削除・型変更・パス名変更など）。
  • 新しめの Cloudflare API を型付きで気持ちよく触りたい人、そろそろ SDK を上げようか迷っている人に刺さる内容だよ。

関連記事