@orizm/cli 3.0.1 → 3.2.0

package/dist/docs/features/cli/project-linking.md

@@ -0,0 +1,58 @@
+<!-- source: docs/src/app/features/cli/project-linking/page.mdx -->
+
+# プロジェクトのリンク
+
+多くのコマンドは、操作対象のプロジェクトを必要とします。Orizm CLI は作業ディレクトリを特定のプロジェクトに「リンク」しておくことで、コマンドのたびにプロジェクト名を指定しなくて済むようにします。
+
+## `.orizm/project.json`
+
+リンク情報は、リポジトリ内の `.orizm/project.json` に保存されます。
+
+```json filename=".orizm/project.json"
+{
+  "projectName": "my-project",
+  "organizationName": "my-organization"
+}
+```
+
+CLI は、コマンドを実行したディレクトリから親方向にたどって最寄りの `.orizm/project.json` を探します。そのため、リポジトリのサブディレクトリから実行してもリンクが効きます。
+
+> [!NOTE]
+> `.orizm/` は `.gitignore` に追加することを推奨します。これにより、開発者ごとに別のプロジェクト（個人のステージング環境など）へリンクできます。`orizm link` は初回リンク時に `.gitignore` への追記を提案します。
+
+## ディレクトリをリンクする
+
+```sh copy
+orizm link
+```
+
+2 ステップの対話で、所属組織を選び、その組織のプロジェクトを選びます。選択結果が `.orizm/project.json` に書き込まれます。`orizm link` は対話的な操作のため、ターミナル（TTY）が必要です。
+
+プロジェクト未リンクのディレクトリでプロジェクトを必要とするコマンドを実行した場合も、ターミナルであればその場でリンクの選択を求められ、そのままコマンドが続行します。
+
+## プロジェクトの解決順序
+
+プロジェクトを対象とするコマンドは、次の順序で対象を決めます。
+
+1. `--project <name>` フラグ（その実行だけ上書き）
+2. 環境変数 `ORIZM_PROJECT`
+3. 最寄りの `.orizm/project.json` の `projectName`
+
+いずれでも解決できず、かつターミナルでない場合は、エラーで終了します。
+
+## 組織の解決順序
+
+`orizm project list` や `orizm project create` のように、プロジェクトではなく組織を対象とするコマンドは、次の順序で組織を決めます。
+
+1. `--organization <name>` フラグ
+2. `.orizm/project.json` の `organizationName`
+
+組織名を指定する環境変数はありません。CI で組織を指定する場合は `--organization` を使ってください。
+
+## CI でのプロジェクト指定
+
+CI では `.orizm/project.json` をコミットしない構成が一般的です。その場合は `ORIZM_PROJECT` で対象を指定します。
+
+```sh copy
+ORIZM_PROJECT=my-project pnpm exec orizm schema push --yes
+```

package/dist/docs/features/cli/quickstart.md

@@ -0,0 +1,83 @@
+<!-- source: docs/src/app/features/cli/quickstart/page.mdx -->
+
+# クイックスタート
+
+Orizm CLI をインストールしてから、スキーマを適用し SDK の型を生成するまでの最短経路を説明します。
+
+### インストール
+
+プロジェクトに `@orizm/cli` を devDependency として追加します。
+
+```sh npm2yarn copy
+npm install --save-dev @orizm/cli
+```
+
+以降の例では `orizm` を直接呼び出しますが、パッケージマネージャー経由なら `pnpm exec orizm ...` のように実行します。
+
+### 接続先を確認する
+
+既定の接続先は本番環境（`https://app.orizm.com`）です。ローカルやステージングのサーバーに向ける場合は `ORIZM_BASE_URL` を設定します。
+
+```sh copy
+export ORIZM_BASE_URL=http://localhost:4000
+```
+
+設定できる環境変数は [環境変数と接続先](./configuration.md) を参照してください。
+
+### サインインする
+
+ブラウザが開き、OAuth2 でサインインします。完了するとトークンがローカルに保存され、以降のコマンドで使われます。
+
+```sh copy
+orizm auth login
+```
+
+```sh copy
+orizm auth status
+```
+
+`orizm auth status` で、誰として・どの接続先にサインインしているかを確認できます。
+
+> [!NOTE]
+> CI や自動化スクリプトではブラウザを開けません。その場合は `ORIZM_API_KEY` に
+> Developer API キーを設定してサインインを省略します。詳しくは
+> [認証](./authentication.md) を参照してください。
+
+### ディレクトリをプロジェクトにリンクする
+
+組織とプロジェクトを対話的に選ぶと、`.orizm/project.json` が作成されます。以降のコマンドはこのプロジェクトを既定の対象にします。
+
+```sh copy
+orizm link
+```
+
+### スキーマを適用する
+
+`orizm.config.ts` にスキーマを定義し、サーバーに適用します。スキーマの書き方は [スキーマ](../schema/about.md) を参照してください。
+
+適用前に差分を確認したいときは `--dry-run` を付けます。
+
+```sh copy
+orizm schema push --dry-run
+```
+
+差分を確認したら適用します。
+
+```sh copy
+orizm schema push
+```
+
+### SDK の型を生成する
+
+適用したスキーマから、CMS SDK / Consumer SDK 用の型コードを生成します。
+
+```sh copy
+orizm codegen cms
+orizm codegen consumer
+```
+
+## 次のステップ
+
+- 各コマンドの詳細: [コマンドリファレンス](./commands.md)
+- 認証の仕組みと API キーの使い方: [認証](./authentication.md)
+- `--json` での出力や CI での利用: [出力とスクリプティング](./output.md)

package/dist/docs/features/cli.md

@@ -0,0 +1,56 @@
+<!-- source: docs/src/app/features/cli/page.mdx -->
+
+# Orizm CLI
+
+Orizm CLI（`orizm`）は、Orizm のプロジェクトをターミナルから操作する開発者向けのコマンドラインツールです。スキーマの適用、SDK の型生成、コンテンツ・APIキー・ユーザー・バケット・Webhook の管理までを、ひとつのコマンドで扱えます。
+
+```sh npm2yarn copy
+npm install --save-dev @orizm/cli
+```
+
+インストールすると `orizm` コマンドが使えます。パッケージマネージャー経由で実行する場合は `pnpm exec orizm ...` や `npx orizm ...` のように呼び出します。
+
+> [!NOTE]
+> v2 から移行する場合は、コマンド体系と認証方式が変わっています。[CLI移行ガイド
+> (v2→v3)](../resources/cli-v2-to-v3-migration-guide.md) を参照してください。
+
+## 基本的な流れ
+
+Orizm CLI は「**認証する → ディレクトリをプロジェクトにリンクする → 操作する**」の 3 ステップで使います。
+
+1. **認証** — `orizm auth login` でブラウザからサインインします。CI など自動化環境では `ORIZM_API_KEY` を使います。詳しくは [認証](./cli/authentication.md) を参照してください。
+2. **リンク** — `orizm link` で、作業ディレクトリを操作対象のプロジェクトに結び付けます。以降のコマンドはこのプロジェクトを既定の対象にします。詳しくは [プロジェクトのリンク](./cli/project-linking.md) を参照してください。
+3. **操作** — `orizm schema push` や `orizm content list` など、目的のコマンドを実行します。
+
+はじめて使うときは [クイックスタート](./cli/quickstart.md) が最短経路です。
+
+## コマンドの全体像
+
+コマンドは `orizm <名詞> <動詞>` の形に統一されています（例: `orizm schema push`、`orizm key consumer list`）。各カテゴリーの詳細は [コマンドリファレンス](./cli/commands.md) を参照してください。
+
+| カテゴリー | コマンド | 用途 |
+| --- | --- | --- |
+| [auth](./cli/commands/auth.md) | `orizm auth login` / `logout` / `status` | サインインとセッション確認 |
+| [link](./cli/commands/link.md) | `orizm link` | ディレクトリとプロジェクトの結び付け |
+| [org](./cli/commands/org.md) | `orizm org list` | 所属組織の一覧 |
+| [project](./cli/commands/project.md) | `orizm project list` / `get` / `create` / `update` / `delete` | プロジェクトのライフサイクル |
+| [schema](./cli/commands/schema.md) | `orizm schema push` / `list` / `get` / `validate` / `erd` | スキーマ定義の適用と参照 |
+| [codegen](./cli/commands/codegen.md) | `orizm codegen cms` / `consumer` | SDK 型コードの生成 |
+| [key](./cli/commands/key.md) | `orizm key consumer ...` / `orizm key management ...` | APIキーの管理 |
+| [project-user](./cli/commands/project-user.md) | `orizm project-user ...` | プロジェクトユーザー（RBAC）の管理 |
+| [content](./cli/commands/content.md) | `orizm content list` / `get` / `create` / `update` / `delete` | テーブルコンテンツの操作 |
+| [bucket](./cli/commands/bucket.md) | `orizm bucket list` / `orizm bucket object ...` | バケットとオブジェクトの操作 |
+| [webhook](./cli/commands/webhook.md) | `orizm webhook list` / `get` / `create` / `update` / `delete` | Webhook の管理 |
+| [agent](./cli/commands/agent.md) | `orizm agent init` | AI コーディングエージェント連携（同梱 docs への参照設定） |
+
+## グローバルフラグ
+
+すべてのコマンドで次のフラグが使えます。
+
+| フラグ | 説明 |
+| --- | --- |
+| `--json` | 結果を機械可読な JSON で標準出力に出します。 |
+| `--debug` | デバッグログを標準エラー出力に出します（環境変数 `ORIZM_DEBUG` でも有効化できます）。 |
+| `--no-color` | カラー出力を抑制します（環境変数 `NO_COLOR` も尊重します）。 |
+
+プロジェクトを対象とするコマンドでは、対象を一時的に切り替える `--project <name>` も使えます。出力の扱いやスクリプトでの利用については [出力とスクリプティング](./cli/output.md) を参照してください。

package/dist/docs/features/cms-sdk/account.md

@@ -0,0 +1,122 @@
+<!-- source: docs/src/app/features/cms-sdk/account/page.mdx -->
+
+# アカウントの操作
+
+CMS SDKでログインユーザーのアカウントの操作方法を説明します。以下の内容を解説します。
+
+- ログイン
+- ログアウト
+- セッション状態の確認
+- ユーザー情報の取得
+- ユーザー情報の更新
+- メールアドレスの変更
+- パスワードの変更
+- アカウントページURLの取得
+
+## ログイン
+
+next-auth の `signIn()` 関数を使用してログインを実装します。
+
+```tsx copy
+import { signIn } from "next-auth/react";
+
+const handleSignIn = () => signIn();
+
+<button onClick={handleSignIn}>ログイン</button>;
+```
+
+## ログアウト
+
+next-auth の `signOut()` と `logoutOrizm()` を利用してログアウトを実装します。
+
+```tsx copy
+import { signOut } from "next-auth/react";
+import { logoutOrizm } from "@orizm/cms-sdk";
+
+const handleSignOut = async () => {
+  await signOut();
+  logoutOrizm("your-project-name");
+};
+
+<button onClick={handleSignOut}>ログアウト</button>;
+```
+
+## セッション状態の確認
+
+next-auth の `useSession()` フックで現在のログイン状態を確認できます。
+
+```tsx copy
+import { useSession } from "next-auth/react";
+
+const { status } = useSession();
+
+if (status === "loading") {
+  return <p>Loading...</p>;
+}
+if (status === "unauthenticated") {
+  return <p>Not logged in</p>;
+}
+return <p>Logged in</p>;
+```
+
+## ユーザー情報の取得
+
+`userinfo.userinfo()` で現在ログインしているユーザーの情報を取得できます。
+
+```tsx copy
+const data = await client.userinfo.userinfo();
+```
+
+## ユーザー情報の更新
+
+`userinfo.update()` でユーザーの表示名を更新できます。
+
+```tsx copy
+const data = await client.userinfo.update({
+  name: "John Doe",
+});
+```
+
+## メールアドレスの変更
+
+Orizmのアカウントページを通じてメールアドレスを変更することができます。  
+アカウントページへのリンクを設置する方法は [アカウントページURLの取得](./account.md#アカウントページURLの取得) を参照してください。
+
+アカウントページ経由ではなく、直接APIを使用してメールアドレスを変更することも可能です。  
+`userinfo.changeEmail()` を使用して、ユーザーのメールアドレスを変更します。
+
+```tsx copy
+const data = await client.userinfo.changeEmail({
+  email: "new-email@example.com",
+});
+```
+
+## パスワードの変更
+
+Orizmのアカウントページを通じてパスワードを変更することができます。  
+アカウントページへのリンクを設置する方法は [アカウントページURLの取得](./account.md#アカウントページURLの取得) を参照してください。
+
+アカウントページ経由ではなく、直接APIを使用してパスワードを変更することも可能です。  
+`userinfo.changePassword()` を使用して、ユーザーのパスワードを変更します。
+
+```tsx copy
+const data = await client.userinfo.changePassword({
+  currentPassword: "current-password",
+  newPassword: "new-password",
+});
+```
+
+## アカウントページURLの取得
+
+`getOrizmAccountPageURL()` を使用して、ユーザーがアカウント情報を管理できるOrizmアカウントページへのURLを生成できます。  
+アカウントページではメールアドレスとパスワードの変更が可能です。
+
+```tsx copy
+import { getOrizmAccountPageURL } from "@orizm/cms-sdk";
+
+const accountPageURL = getOrizmAccountPageURL();
+
+<a href={accountPageURL} target="_blank" rel="noopener noreferrer">
+  アカウント設定
+</a>;
+```

package/dist/docs/features/cms-sdk/auth.md

@@ -0,0 +1,122 @@
+<!-- source: docs/src/app/features/cms-sdk/auth/page.mdx -->
+
+# 認証
+
+> [!WARNING]
+> 現在、`next-auth@4` を使用した Next.js との統合のみサポートしています。
+
+このドキュメントではCMS SDKを利用した認証処理の実装方法を説明します。現在、next-auth v4を使用した認証をサポートしています。このガイドでは以下の内容を学べます：
+
+- next-auth v4のインストール方法
+- 認証設定の構成方法
+- 認証APIの実装方法
+- アクセス制御のためのMiddlewareの設定方法
+
+## next-auth v4 のインストール
+
+next-auth v4をインストールするには以下のコマンドを実行します。auth.jsによる導入例は現時点で提供していません。
+
+```bash
+pnpm add next-auth@4
+```
+
+## 認証設定の構成
+
+認証設定は`authOptions`オブジェクトで構成します。`app/api/auth/[...nextauth].js`ファイルを作成し、以下のコードを記述します。
+
+```ts
+import { generateOrizmNextAuth } from "@orizm/cms-sdk/next-auth";
+import type { NextAuthOptions, Session } from "next-auth";
+import type { JWT } from "next-auth/jwt";
+
+export interface CustomSession extends Session {
+  accessToken: string;
+}
+
+interface ExtendedToken extends JWT {
+  accessToken?: string;
+}
+
+const orizmAuth = generateOrizmNextAuth({
+  id: "Orizm",
+  name: "Orizm",
+  clientId: process.env.ORIZM_CLIENT_ID,
+  clientSecret: process.env.ORIZM_CLIENT_SECRET,
+  projectName: process.env.NEXT_PUBLIC_ORIZM_PROJECT,
+  baseURL: process.env.NEXT_PUBLIC_ORIZM_BASE_URL,
+});
+
+export const authOptions = {
+  secret: process.env.NEXTAUTH_SECRET,
+  // Orizm認証プロバイダーを設定
+  providers: [orizmAuth.provider],
+  // JWTベースのセッション管理を設定
+  session: {
+    strategy: "jwt",
+  },
+  callbacks: {
+    async jwt(params) {
+      const extendedToken: ExtendedToken = params.token as ExtendedToken;
+      if (params.account) {
+        if (params.account.accessToken) {
+          extendedToken.accessToken = params.account.accessToken as string;
+        }
+      }
+      return orizmAuth.jwtCallback({ ...params, token: extendedToken });
+    },
+    async session(params) {
+      const extendedToken: ExtendedToken = params.token as ExtendedToken;
+      const customSession: CustomSession = {
+        ...params.session,
+        accessToken: extendedToken.accessToken ?? "",
+      };
+      return orizmAuth.sessionCallback({ ...params, session: customSession });
+    },
+  },
+  debug: process.env.NEXT_PUBLIC_VERCEL_ENV === "development",
+};
+```
+
+上記の設定により、`/api/auth/*`パスに認証関連のAPIエンドポイントが自動生成され、Next.jsのルーティングで利用できるようになります。
+
+## 認証APIの実装
+
+認証APIはNext.jsのAPI Routesを使って実装されます。`app/api/auth/[...nextauth].js`ファイルにより、次のAPIエンドポイントが自動的に提供されます：
+
+- `/api/auth/signin` - サインイン画面の提供
+- `/api/auth/signout` - サインアウト処理
+- `/api/auth/session` - セッション情報の取得
+- 各認証プロバイダーに対応した認証フロー
+
+必要に応じて`authOptions`の設定を拡張し、カスタムコールバックやイベントハンドラを追加してください。
+
+## Middlewareによるアクセス制御
+
+認証済みユーザーのみにアクセスを許可するには、Next.jsのMiddlewareを使用します。`src/middleware.ts`ファイルを作成し、以下のコードを追加します：
+
+```ts
+import { withAuth } from "next-auth/middleware";
+
+export default withAuth({
+  pages: {
+    signIn: "/signin",
+  },
+});
+
+/**
+ * @see https://vercel.com/docs/functions/edge-middleware/middleware-api#match-based-on-a-negative-lookahead
+ */
+export const config = {
+  matcher: [
+    "/((?!_next|[^?]*\\.(?:html?|css|js(?!on)|jpe?g|webp|png|gif|svg|ttf|woff2?|ico|csv|docx?|xlsx?|zip|webmanifest)|signin|api).*)",
+  ],
+};
+```
+
+アクセス制御の設定をカスタマイズするには、matcherパターンを変更するか、認可コールバックを追加してください。
+
+## 関連ドキュメント
+
+詳細な情報は、公式ドキュメントを参照してください：
+
+- [NextAuth.js 公式ドキュメント](https://next-auth.js.org/getting-started/introduction)

package/dist/docs/features/cms-sdk/bucket.md

@@ -0,0 +1,113 @@
+<!-- source: docs/src/app/features/cms-sdk/bucket/page.mdx -->
+
+# バケットの操作
+
+CMS SDKを使用したバケットの操作方法を説明します。このドキュメントでは以下の内容を解説します。
+
+- オブジェクトの単体取得・一覧取得
+- ファイルのアップロード
+- オブジェクトの削除
+
+## オブジェクトの一覧取得
+
+バケット内のオブジェクト一覧を取得するには、`list()` を使用します。
+
+```ts
+const data = await bucketClient.list();
+```
+
+### フィルタリング
+
+`filter` プロパティを使用して、条件に一致するオブジェクトのみを取得できます。
+
+以下の項目でフィルタ可能です。
+
+- `key`: オブジェクトのキー
+- `group`: オブジェクトのグループ
+
+以下の例では、キーに `example` を含むオブジェクトを取得します。
+
+```ts
+const data = await bucketClient.list({
+  filter: {
+    key: { $contains: "example" },
+  },
+});
+```
+
+条件の指定方法については、[フィルタ](./fetch-contents.md#フィルタ) を参照してください。
+
+### ページネーション
+
+`limit` と `offset` プロパティを使用して、ページネーションを行うことができます。
+
+```ts
+const data = await bucketClient.list({
+  limit: 10,
+  offset: 0,
+});
+```
+
+`limit` パラメータを指定しない場合、デフォルトで100件まで取得されます。
+
+## ファイルのアップロード
+
+ファイルをバケットにアップロードするには、`upload()` を使用します。
+
+```ts
+const data = await bucketClient.upload(file);
+```
+
+### オプション付きアップロード
+
+カスタムキーやグループを指定してアップロードできます。キーを指定しない場合は自動的に生成されます。
+
+```ts
+const data = await bucketClient.upload(file, {
+  key: "custom-key",
+  group: "admin",
+});
+```
+
+## オブジェクトの取得
+
+キーを指定して単一のオブジェクトを取得します。
+
+```ts
+const data = await bucketClient.get(objectKey);
+```
+
+## オブジェクトの削除
+
+### 単一オブジェクトの削除
+
+キーを指定して単一のオブジェクトを削除します。
+
+```ts
+const data = await bucketClient.delete(objectKey);
+```
+
+### 複数オブジェクトの削除
+
+複数のオブジェクトを一括削除します。
+
+```ts
+await bucketClient.deleteObjects({});
+```
+
+> [!WARNING]
+> `deleteObjects()`
+> でフィルタを指定しない場合、バケット内のすべてのオブジェクトが削除されます。
+
+### フィルタを使用した削除
+
+特定の条件に一致するオブジェクトを削除できます。
+
+```ts
+await bucketClient.deleteObjects({
+  filter: {
+    key: { $contains: "old_" },
+    group: "admin",
+  },
+});
+```

package/dist/docs/features/cms-sdk/cli.md

@@ -0,0 +1,104 @@
+<!-- source: docs/src/app/features/cms-sdk/cli/page.mdx -->
+
+# CMS CLI
+
+CMS CLIで利用可能なコマンドを説明します。
+
+> [!CAUTION]
+> 廃止予定
+>
+> @orizm/cms-sdk や @orizm/consumer-sdk に同梱されている CLI は廃止が予定されています。
+> 代わりに @orizm/cli パッケージを利用してください。
+> SDK同梱のCLIから新しいCLIへの移行方法は [CLI移行ガイド](../../resources/cli-migration-guide.md) や [CLI](../cli.md) を参照してください。
+>
+
+## update
+
+Orizmプロジェクトにスキーマを適用します。
+
+```sh copy
+orizm-cms update
+```
+
+このコマンドは以下の処理を行います。
+
+1. 設定ファイル（デフォルトでは `./orizm.config.ts`）からスキーマを読み込み
+1. どのような変更が行われるか確認（意図しないものであればこの時点でキャンセル可能）
+1. Orizmプロジェクトにスキーマを適用
+1. クライアントコードとTypeScriptの型定義ファイルを生成
+
+以下のオプションがあります。
+
+### --env \<path>
+
+環境変数ファイルのパスを指定します。デフォルトは `.env.x.local` です。
+
+```sh copy
+orizm-cms update --env ./path/to/file
+```
+
+環境変数ファイルは必須です。以下のように設定してください。`<Orizmプロジェクト名>` と `<Developer API Key>` はそれぞれプロジェクト名とAPIキーに置き換えてください。プロジェクト名とAPIキーは、プロジェクトの設定ページから取得できます。
+
+```ini copy filename=".env.x.local"
+ORIZM_BASE_URL=https://app.orizm.com
+ORIZM_PROJECT=<Orizmプロジェクト名>
+ORIZM_API_KEY=<Developer API Key>
+```
+
+### --config \<path>
+
+設定ファイルのパスを指定します。デフォルトは `./orizm.config.ts` です。
+
+```sh copy
+orizm-cms update --config ./path/to/file.ts
+```
+
+### --output \<path>
+
+生成されるコードの出力先ディレクトリを指定します。デフォルトは `./src/orizm` です。
+
+```sh copy
+orizm-cms update --output ./path/to/directory
+```
+
+### --dry-run
+
+実際にスキーマを適用することなく、どのような変更が行われるかを確認できます。
+
+```sh copy
+orizm-cms update --dry-run
+```
+
+### -y, --yes
+
+全てのプロンプトに対して `yes` で回答します。CI環境などインタラクティブな操作ができない場合に利用します。
+
+```sh copy
+orizm-cms update --yes
+```
+
+## generate
+
+クライアントコードとTypeScriptの型定義ファイルを生成します。
+
+```sh copy
+orizm-cms generate
+```
+
+以下のオプションがあります。
+
+### --config \<path>
+
+設定ファイルのパスを指定します。デフォルトは `./orizm.config.ts` です。
+
+```sh copy
+orizm-cms update --config ./path/to/file.ts
+```
+
+### --output \<path>
+
+生成されるコードの出力先ディレクトリを指定します。デフォルトは `./src/orizm` です。
+
+```sh copy
+orizm-cms update --output ./path/to/directory
+```