FeaturesConsumer SDKv2への移行手順

CMS SDK v2 への移行

このドキュメントでは、Consumer SDK v1 から v2 への移行手順と注意点について説明します。

変更点の概要

  • CLI の廃止
  • @orizm/common 依存を peerDependency から削除

移行手順

CLI の変更

@orizm/consumer-sdk に含まれていた CLI コマンド (orizm-consumer) は廃止され、@orizm/cli パッケージに統合されました。コマンドを呼び出すプロジェクトで専用の CLI パッケージをインストールし、コマンドを修正してください。

npm install --save-dev @orizm/cli
# 旧
orizm-consumer generate
# 新
orizm consumer generate

@orizm/consumer-sdk v2 を利用する場合、CLI も v2 を利用する必要があります。 CLI の利用方法の詳細は ドキュメント を参照してください。

@orizm/common のアンインストール

@orizm/common@orizm/cms-sdk の peer dependencies から dependencies に変更しました。@orizm/common をコードで利用していない場合は、アンインストールできます。

npm uninstall @orizm/common

ただし、@orizm/common をコードで利用している場合は、最新バージョンがリリースされているためアップデートしてください。

npm install @orizm/common@latest