@orizm/cli 3.1.0 → 3.3.0-beta.0

package/dist/docs/features/cms-sdk/management-user.md

@@ -0,0 +1,244 @@
+<!-- source: docs/src/app/features/cms-sdk/management-user/page.mdx -->
+
+# プロジェクトユーザーの管理
+
+CMS SDKを使用したプロジェクトユーザーの管理方法を説明します。このページでは以下の内容を解説します。
+
+- ユーザーの単体取得・一覧取得
+- ユーザーの招待
+- ユーザーの削除
+- グループの管理
+
+## ユーザーの一覧取得
+
+プロジェクト内のユーザー一覧を取得します。
+
+```ts copy
+const data = await client.userManagement.listUsers();
+```
+
+### フィルタ
+
+特定の条件でユーザーを絞り込むことができます。以下の項目でフィルタが可能です。
+
+- `email`: ユーザーのメールアドレス
+- `name`: ユーザーの名前
+
+以下の例では、名前が一致するユーザーを取得します。
+
+```ts copy
+const data = await client.userManagement.listUsers({
+  filter: { name: "John Doe" },
+});
+```
+
+以下の例では、メールアドレスに `@example.com` を含むユーザーを取得します。
+
+```ts copy
+const data = await client.userManagement.listUsers({
+  filter: { email: { $contains: "@example.com" } },
+});
+```
+
+条件の指定方法については、[フィルタ](./fetch-contents.md#フィルタ) を参照してください。
+
+### ソート
+
+`sort` プロパティを指定して、作成日時または更新日時のどちらかでソートできます。
+
+```ts copy
+const data = await client.userManagement.listUsers({
+  sort: "createdAt",
+});
+```
+
+```ts copy
+const data = await client.userManagement.listUsers({
+  sort: "updatedAt",
+});
+```
+
+`order` プロパティで順序を指定することも可能です。
+
+```ts copy
+const data = await client.userManagement.listUsers({
+  sort: "createdAt",
+  order: "asc",
+});
+```
+
+```ts copy
+const data = await client.userManagement.listUsers({
+  sort: "createdAt",
+  order: "desc",
+});
+```
+
+### ページネーション
+
+取得件数とオフセットを指定してユーザーリストを分割取得します。
+
+```ts copy
+const data = await client.userManagement.listUsers({
+  limit: 10,
+  offset: 0,
+});
+```
+
+`limit` パラメータを指定しない場合、デフォルトで100件まで取得されます。
+
+## ユーザーの詳細取得
+
+指定したIDのユーザー情報を取得します。
+
+```ts copy
+const data = await client.userManagement.getUser(userId);
+```
+
+## ユーザーの招待
+
+新しいユーザーをプロジェクトに招待します。招待メールが送信され、ユーザーはパスワード設定後にプロジェクトに参加できます。
+
+```ts copy
+const data = await client.userManagement.createUserWithEmailInvite({
+  email: "user@example.com",
+  name: "John Doe",
+  groupRoles: [{ group: "admin", role: "editor" }],
+});
+```
+
+## ユーザーの削除
+
+指定したIDのユーザーをプロジェクトから削除します。
+
+```ts copy
+const data = await client.userManagement.deleteUser(userId);
+```
+
+## グループの管理
+
+グループは権限管理のための仕組みです。詳細については、[権限](../schema/authority.md) を参照してください。
+
+### グループの一覧取得
+
+プロジェクト内のグループ一覧を取得します。
+
+```ts copy
+const data = await client.userManagement.listAllGroups();
+```
+
+### グループの削除
+
+指定したグループを削除します。
+
+```ts copy
+await client.userManagement.deleteGroup("groupName");
+```
+
+### グループ内ユーザーの一覧取得
+
+指定したグループに属するユーザーの一覧を取得します。
+
+```ts copy
+const data = await client.userManagement.listUsersInGroup("groupName");
+```
+
+#### フィルタ
+
+`filter` パラメータを使用して、特定の条件でユーザーを絞り込むことができます。以下の項目でフィルタが可能です。
+
+- `email`: ユーザーのメールアドレス
+- `name`: ユーザーの名前
+  以下の例では、名前が一致するユーザーを取得します。
+
+```ts copy
+const data = await client.userManagement.listUsersInGroup("groupName", {
+  filter: { name: "John Doe" },
+});
+```
+
+以下の例では、メールアドレスに `@example.com` を含むユーザーを取得します。
+
+```ts copy
+const data = await client.userManagement.listUsersInGroup("groupName", {
+  filter: { email: { $contains: "@example.com" } },
+});
+```
+
+条件の指定方法については、[フィルタ](./fetch-contents.md#フィルタ) を参照してください。
+
+#### ソート
+
+`sort` プロパティを指定して、作成日時または更新日時のどちらかでソートできます。
+
+```ts copy
+const data = await client.userManagement.listUsersInGroup("groupName", {
+  sort: "createdAt",
+});
+```
+
+```ts copy
+const data = await client.userManagement.listUsersInGroup("groupName", {
+  sort: "updatedAt",
+});
+```
+
+`order` プロパティで順序を指定することも可能です。
+
+```ts copy
+const data = await client.userManagement.listUsersInGroup("groupName", {
+  sort: "createdAt",
+  order: "asc",
+});
+```
+
+```ts copy
+const data = await client.userManagement.listUsersInGroup("groupName", {
+  sort: "createdAt",
+  order: "desc",
+});
+```
+
+#### ページネーション
+
+```ts copy
+const data = await client.userManagement.listUsersInGroup("groupName", {
+  limit: 20,
+  offset: 0,
+});
+```
+
+`limit` パラメータを指定しない場合、デフォルトで100件まで取得されます。
+
+### グループへのユーザー追加
+
+ユーザーIDを指定して、ユーザーを指定したグループに追加し、ロールを設定します。
+
+```ts copy
+const data = await client.userManagement.addUserToGroup({
+  userId: userId,
+  group: "admin",
+  role: "editor",
+});
+```
+
+メールアドレスを指定してユーザーを追加することも可能です。
+
+```ts copy
+const data = await client.userManagement.addUserToGroup({
+  email: "user@example.com",
+  group: "admin",
+  role: "editor",
+});
+```
+
+### グループからのユーザー削除
+
+指定したユーザーをグループから削除します。
+
+```ts copy
+const data = await client.userManagement.removeUserFromGroup({
+  userId: userId,
+  group: "groupName",
+});
+```

package/dist/docs/features/cms-sdk/migrate-to-v2.md

@@ -0,0 +1,152 @@
+<!-- source: docs/src/app/features/cms-sdk/migrate-to-v2/page.mdx -->
+
+# CMS SDK v2 への移行
+
+このドキュメントでは、CMS SDK v1 から v2 への移行手順と注意点について説明します。
+
+## 変更点の概要
+
+- CLI の廃止
+- NextAuth 連携 API のモジュール分離とリネーム
+- `@orizm/common` 依存を peerDependency から削除
+
+## 移行手順
+
+### CLI の変更
+
+`@orizm/cms-sdk` に含まれていた CLI コマンド (`orizm-cms`) は廃止され、`@orizm/cli` パッケージに統合されました。コマンドを呼び出すプロジェクトで専用の CLI パッケージをインストールし、コマンドを修正してください。
+
+```sh npm2yarn copy
+npm install --save-dev @orizm/cli
+```
+
+```sh
+# 旧
+orizm-cms update
+# 新
+orizm schema push
+```
+
+`orizm schema push` はスキーマの適用に特化しています。これまでの `orizm-cms update` のようにクライアントコードや型定義も生成したい場合は、`orizm codegen cms` を続けて実行してください。CLI の利用方法の詳細は [Orizm CLI](../cli.md) を参照してください。
+
+### NextAuth 連携の変更
+
+NextAuth 連携用の API を import するパスが変更され、リネームされました。また、一部のクラスは廃止されました。
+
+次の変更を行ってください。
+
+#### `OrizmNextAuth.generate` を `generateOrizmNextAuth` に置き換える
+
+```ts
+// 旧コード
+import { OrizmNextAuth } from "@orizm/cms-sdk";
+
+const orizmAuth = OrizmNextAuth.generate({
+  id: "Orizm",
+  name: "Orizm",
+  clientId: env.ORIZM_CLIENT_ID,
+  clientSecret: env.ORIZM_CLIENT_SECRET,
+  projectName: env.NEXT_PUBLIC_ORIZM_PROJECT,
+});
+
+// 新コード
+import { generateOrizmNextAuth } from "@orizm/cms-sdk/next-auth";
+
+const orizmAuth = generateOrizmNextAuth({
+  id: "Orizm",
+  name: "Orizm",
+  clientId: env.ORIZM_CLIENT_ID,
+  clientSecret: env.ORIZM_CLIENT_SECRET,
+  projectName: env.NEXT_PUBLIC_ORIZM_PROJECT,
+});
+```
+
+#### `OrizmCMSClient_NextAuthSession` を `OrizmNextAuthCMSClient` に置き換える
+
+```ts
+// 旧コード
+import { OrizmCMSClient_NextAuthSession } from "@orizm/cms-sdk";
+import { CMSClient } from "@repo/orizm/cms";
+import { getServerSession } from "next-auth";
+import { authOptions } from "../auth/auth-options";
+import { env } from "@/env";
+
+export function getServerSideOrizmClient(): CMSClient {
+  return new CMSClient(
+    new OrizmCMSClient_NextAuthSession(
+      {
+        projectName: env.NEXT_PUBLIC_ORIZM_PROJECT,
+        baseURL: env.NEXT_PUBLIC_ORIZM_BASE_URL,
+      },
+      async () => (await getServerSession(authOptions)) ?? undefined,
+    ),
+  );
+}
+
+// 新コード
+import { OrizmNextAuthCMSClient } from "@orizm/cms-sdk/next-auth";
+import { CMSClient } from "@repo/orizm/cms";
+import { getServerSession } from "next-auth";
+import { authOptions } from "../auth/auth-options";
+import { env } from "@/env";
+
+export function getServerSideOrizmClient(): CMSClient {
+  return new CMSClient(
+    new OrizmNextAuthCMSClient(
+      {
+        projectName: env.NEXT_PUBLIC_ORIZM_PROJECT,
+        baseURL: env.NEXT_PUBLIC_ORIZM_BASE_URL,
+      },
+      async () => await getServerSession(authOptions),
+    ),
+  );
+}
+```
+
+#### `OrizmCMSClient_NextAuthFront` の廃止
+
+`OrizmCMSClient_NextAuthFront` クラスは廃止されました。代わりに `OrizmNextAuthCMSClient` クラスを使用してください。
+
+```ts
+// 旧コード
+import { OrizmCMSClient_NextAuthFront } from "@orizm/cms-sdk";
+import { CMSClient } from "@repo/orizm/cms";
+import { env } from "@/env";
+
+const client = new CMSClient(
+  new OrizmCMSClient_NextAuthFront({
+    projectName: env.NEXT_PUBLIC_ORIZM_PROJECT,
+    baseURL: env.NEXT_PUBLIC_ORIZM_BASE_URL,
+  }),
+);
+
+// 新コード
+import { OrizmNextAuthCMSClient } from "@orizm/cms-sdk/next-auth";
+import { CMSClient } from "@repo/orizm/cms";
+import { getSession } from "next-auth/react";
+import { env } from "@/env";
+
+const client = new CMSClient(
+  new OrizmNextAuthCMSClient(
+    {
+      projectName: env.NEXT_PUBLIC_ORIZM_PROJECT,
+      baseURL: env.NEXT_PUBLIC_ORIZM_BASE_URL,
+    },
+    async () => getSession(),
+  ),
+);
+```
+
+### `@orizm/common` のアンインストール
+
+`@orizm/common` を `@orizm/cms-sdk` の peer dependencies から dependencies に変更しました。`@orizm/common` をコードで利用していない場合は、アンインストールできます。
+
+```sh npm2yarn copy
+npm uninstall @orizm/common
+```
+
+ただし、`@orizm/common` をコードで利用している場合は、最新バージョンがリリースされているためアップデートしてください。
+
+```sh npm2yarn copy
+npm install @orizm/common@latest
+```

package/dist/docs/features/cms-sdk/mutation-contents.md

@@ -0,0 +1,190 @@
+<!-- source: docs/src/app/features/cms-sdk/mutation-contents/page.mdx -->
+
+# コンテンツの操作
+
+CMS SDKを使用したコンテンツ操作の方法を説明します。このドキュメントでは以下の内容を解説します。
+
+- コンテンツの作成・更新・削除
+- 下書きコンテンツの公開
+- 公開データの下書き化
+- storage型カラムにデータを保存
+
+> [!NOTE]
+>
+> 下書き機能を利用するにはテーブルの下書き管理機能を有効にする必要があります。詳細は [下書き管理](../draft.md) を参照してください。
+>
+
+## コンテンツの作成
+
+指定したテーブルに新しいコンテンツを公開状態で作成します。
+
+```ts copy
+const data = await client.tables.blog.create({
+  slug: "hello-world",
+  title: "Hello World",
+  content: "This is my first post.",
+});
+```
+
+### 下書きでの作成
+
+`draft` オプションを `true` にすると、コンテンツを下書き状態で作成できます。
+
+```ts copy
+const data = await client.tables.blog.create(
+  {
+    slug: "hello-world",
+    title: "Hello World",
+    content: "Draft content here...",
+  },
+  { draft: true },
+);
+```
+
+## コンテンツの更新
+
+指定したIDのコンテンツを更新します。
+
+```ts copy
+const data = await client.tables.blog.update(blogId, {
+  title: "Updated Title",
+  content: "Updated content.",
+});
+```
+
+### 部分更新
+
+`update` メソッドでは、すべてのフィールドを指定する必要はありません。更新したいフィールドのみを指定することで部分更新が可能です。
+
+以下の例では、`title` のみを更新し、その他のフィールドは変更されません。
+
+```ts copy
+const data = await client.tables.blog.update(blogId, {
+  title: "Updated Title",
+});
+```
+
+`undefined` な値のフィールドは変更されず、既存の値が保持されます。  
+`null` を明示的に設定した場合は、そのフィールドが `null` に更新されます。
+
+以下の例では、`title` は変更されず、`content` は `null` に更新されます。
+
+```ts copy
+await client.tables.blog.update(blogId, {
+  title: undefined,
+  content: null,
+});
+```
+
+### 下書きでの更新
+
+`draft` オプションを `true` にすると下書き状態でコンテンツを更新します。公開されているコンテンツには影響しません。
+
+```ts copy
+const data = await client.tables.blog.update(
+  blogId,
+  {
+    title: "Draft Title",
+    content: "Work in progress...",
+  },
+  { draft: true },
+);
+```
+
+## コンテンツの削除
+
+指定したIDの公開コンテンツを削除します。
+
+```ts copy
+await client.tables.blog.delete(blogId);
+```
+
+### 下書きの削除
+
+`draft` オプションを `true` にすると、下書き状態のコンテンツのみを削除します。公開されているコンテンツは残ります。
+
+```ts copy
+await client.tables.blog.delete(blogId, {
+  draft: true,
+});
+```
+
+## 下書きコンテンツの公開
+
+下書き状態のコンテンツを公開します。
+
+```ts copy
+const data = await client.tables.blog.publish(blogId);
+```
+
+### 下書きの更新と同時公開
+
+コンテンツを更新しながら同時に公開することも可能です。
+
+```ts copy
+const data = await client.tables.blog.publish(blogId, {
+  title: "Fixed Title",
+  content: "Fixed content.",
+});
+```
+
+## 公開コンテンツの下書き化
+
+公開されているコンテンツを下書き状態に戻します。
+
+```ts copy
+const data = await client.tables.blog.unpublish(blogId);
+```
+
+## フォーム受信データの管理
+
+> [!NOTE]
+>
+> テーブルのフォーム管理機能が有効な場合のみ利用可能です。詳細は [フォーム管理](../form/about.md) を参照してください。
+>
+
+### 受信データの更新
+
+受信データの内容は変更できませんが、管理用のカラムを更新できます。  
+例えば `status` カラムに対応状況を記録したり、 `memo` カラムに情報を残しておくことも可能です。
+
+```ts copy
+await client.tables.form.submissions(formId).update(blogId, {
+  status: "in_progress",
+  memo: "Started working on this.",
+});
+```
+
+以下のデータは読み取り専用です。
+
+- `_content`: 受信データの内容
+- `_formSchema`: フォームのスキーマ情報
+- `_attachments`: 添付ファイル
+
+### 受信データの削除
+
+`delete()` メソッドで受信データを削除できます。
+
+```ts copy
+await client.tables.form.submissions(formId).delete(submissionId);
+```
+
+## storage型カラムにデータを保存
+
+storage型カラムについては [storage](../schema/database.md#storage) を参照してください。
+
+`uploadFile()` メソッドを使用してファイルをアップロードします。このとき、戻り値として `handle` を取得します。
+
+```ts copy
+const { handle } = await orizm.tables.blog.uploadFile(file);
+```
+
+次に `create()` や `update()` などのメソッドを使用してレコードを作成や更新します。このとき、storage型カラムに `handle` を設定します。
+
+```ts copy
+await orizm.tables.blog.update({
+  thumbnail: { handle },
+});
+```
+
+この2ステップでファイルをレコードに紐づけることができます。

package/dist/docs/features/console/audit-logs.md

@@ -0,0 +1,55 @@
+<!-- source: docs/src/app/features/console/audit-logs/page.mdx -->
+
+# 監査ログ
+
+監査ログは、プロジェクト内で発生した操作やイベントの履歴を記録・確認できる機能です。  
+セキュリティや運用管理、トラブルシュートのために活用できます。
+
+## 概要
+
+監査ログには、操作日時・実行者・IPアドレス・アクション内容などが記録されます。
+主要な管理操作（ユーザー管理、テーブル・バケット操作、スキーマ変更など）が自動で記録されます。
+
+## アクセス方法
+
+プロジェクト詳細画面のヘッダーメニューから「**Audit Logs**」タブをクリックします。
+
+## ログの閲覧・検索
+
+ログは新しい順に一覧表示されます。各行には「日時」「実行者」「IPアドレス」「アクション内容」が表示されます。ページネーションや表示件数の切り替えが可能です。
+
+## アクション一覧
+
+| アクション例                 | 説明                                                          |
+| ---------------------------- | ------------------------------------------------------------- |
+| session.login                | ログイン                                                      |
+| session.logout               | ログアウト                                                    |
+| session.passwordResetRequest | パスワードリセットリクエスト                                  |
+| session.passwordResetConfirm | パスワードリセット                                            |
+| userinfo.update              | 自分のアカウント情報更新                                      |
+| userManagement.invite        | ユーザー招待                                                  |
+| userManagement.remove        | ユーザー削除                                                  |
+| userManagement.update        | ユーザー情報更新                                              |
+| userManagement.updateRole    | 権限・グループ変更                                            |
+| definition.update            | スキーマ変更                                                  |
+| table.create                 | コンテンツ作成                                                |
+| table.update                 | コンテンツ更新                                                |
+| table.delete                 | コンテンツ削除                                                |
+| table.publish                | コンテンツ公開                                                |
+| table.unpublish              | コンテンツ非公開                                              |
+| bucket.create                | バケットオブジェクト作成                                      |
+| bucket.update                | バケットオブジェクト更新                                      |
+| bucket.delete                | バケットオブジェクト削除                                      |
+| storageItem.upload           | ファイルアップロード                                          |
+| dictionary.add               | 検索辞書エントリ登録                                          |
+| dictionary.update            | 検索辞書エントリ更新                                          |
+| dictionary.delete            | 検索辞書エントリ削除                                          |
+| otpChallenge.success         | ワンタイムパスワード・challenge 成功                          |
+| otpChallenge.tooManyAttempts | ワンタイムパスワード・challenge 試行回数が多すぎる            |
+| otpChallenge.invalid         | ワンタイムパスワード・challenge OTPが無効な状態でAPIコール    |
+| otpChallenge.unknownError    | ワンタイムパスワード・challenge 原因不明のエラー              |
+| otpVerify.challengeNotFound  | ワンタイムパスワード・verify challenge状態ではないがAPIコール |
+| otpVerify.invalidCode        | ワンタイムパスワード・verify 無効なコード                     |
+| otpVerify.tooManyAttempts    | ワンタイムパスワード・verify 試行回数が多すぎる               |
+| otpVerify.invalid            | ワンタイムパスワード・verify OTPが無効な状態でAPIコール       |
+| otpVerify.unknownError       | ワンタイムパスワード・verify 原因不明のエラー                 |