SDK 0.3.0｜ブラウザ認証から最初の取得までを案内

初期設定をまとめて実行

npx notcms init から、ブラウザでの認証、プロジェクトへのSDK導入、データベースの構造を表すスキーマの取得まで進められるようになりました。設定後には、最初のコンテンツを取得するコード例を表示します。

認証だけを行う場合は、npx notcms login を利用できます。ブラウザでワークスペースを選ぶと、認証情報をプロジェクトの環境ファイルに保存します。

スキーマの変更を確認

• npx notcms pull で、データベース・ID・プロパティの変更点を確認できます。
• npx notcms pull --check で、ファイルを書き換えずにスキーマの更新が必要か確認できます。CIでのチェックにも利用できます。
• スキーマの出力先をプロジェクト直下にすると、ファイルを生成できない問題を修正しました。
• コマンドの実行に失敗した場合は終了コード1を返すため、CIで失敗を検出できます。

更新時の注意

notcms-kit を使用している場合は、依存パッケージとコマンドを notcms に変更してください。

import.meta.env からの環境変数の自動取得を廃止しました。利用する実行環境の環境変数を使うか、Clientの設定に認証情報を明示してください。import.meta.env を利用するサーバー側のコードでは、次のように渡せます（schema は生成済みのスキーマです）。

const nc = new Client({
  schema,
  secretKey: import.meta.env.NOTCMS_SECRET_KEY,
  workspaceId: import.meta.env.NOTCMS_WORKSPACE_ID,
});

更新方法

npm install notcms@0.3.0
npx notcms init