SDKとCLI

型付きクライアント

型付きクライアントは@foir/sdkにあり、他のクライアントと同じエンドポイントにGraphQLを送り、GraphQLドキュメントを代わりに書きます。型付き呼び出し1回が1リクエストです。既定ではモデルのすべてのスカラーフィールドを返し、pick、omit、includeで選択を調整できます。

型はfoir typesで作られ、キーごとに生成されるため、そのキーで実行できないオペレーションは型にありません。

クライアントが動く場所

クライアントはfetchのみを使い、モジュールレベルの状態を持ちません。ドキュメントでは、Hydrogen、React Routerのローダー、TanStack Start、エッジランタイムでの使い方を扱っています。同じパッケージの他のエントリポイントが、エンドユーザーのセッション、ライブ更新、メディアを扱います。

CLIが扱う範囲

@foir/cliはfoirコマンドをインストールします。コマンドグループは、レコード、モデル、ロケール、メディア、検索、ロールアウト、リリース、キャッシュ、APIキー、エンドユーザーとそのロール、組織、オペレーション、フック、スケジュール、シークレット、サインインプロバイダー、エクスポート、型生成に対応します。また、プッシュで設定ファイルを適用します。コマンドの一覧はCLIリファレンスにあり、どのプラットフォーム操作にコマンドがあるかはドキュメントのインテントリファレンスで確認できます。

スクリプト向けの出力とサインイン

どのコマンドも既定では表を出力し、パイプ用にJSON、JSON Lines、IDのみを出力できます。ペイロードはフラグ、ファイル、標準入力から渡します。サインインはブラウザーで行い、SSH、コンテナー、CI向けにはデバイスコードフローがあり、ヘッドレス実行では環境にAPIキーを設定します。