@orizm/cli 3.1.0 → 3.3.0-beta.0

package/dist/docs/features/history.md

@@ -0,0 +1,152 @@
+<!-- source: docs/src/app/features/history/page.mdx -->
+
+# 履歴管理
+
+履歴管理機能を使用すると、コンテンツの編集履歴を保存できます。誰が、いつ、どのような変更を行ったかを記録し、過去の状態に復元できます。
+
+## ユースケース例
+
+CMSにコンテンツの履歴管理機能を実装することで、以下のように活用できます。
+
+- 誤って編集したデータを編集前の状態に復元する
+- 複数の編集者で作業する際に、誰がいつどのような変更を行ったか記録する
+
+## 機能の有効化
+
+スキーマで [テーブル](./schema/database.md) ごとに有効化できます。`enableHistory` プロパティを `true` に設定します。
+
+```ts copy filename="orizm.config.ts" showLineNumbers {7}
+import { defineConfig } from "@orizm/cli/config";
+
+export default defineConfig({
+  tables: {
+    blog: {
+      columns: {},
+      enableHistory: true,
+    },
+  },
+});
+```
+
+## 記録される情報
+
+### コンテンツに対する操作
+
+コンテンツに対する以下の操作を記録します。
+
+| 操作          | 概要               |
+| ------------- | ------------------ |
+| **create**    | コンテンツの作成   |
+| **update**    | コンテンツの更新   |
+| **publish**   | コンテンツの公開   |
+| **unpublish** | コンテンツの非公開 |
+
+### 編集したユーザー
+
+操作を行ったCMSユーザーの情報を記録します。APIキーによる操作の場合は、APIキーの情報を記録します。
+
+### 使用されたAPIの種類
+
+以下のAPIの種類を記録します。
+
+| API                | 概要                               |
+| ------------------ | ---------------------------------- |
+| **Developer API**  | 開発者コンソールからの操作         |
+| **Management API** | CMSアプリケーションからの操作      |
+| **Consumer API**   | Consumerアプリケーションからの操作 |
+
+### コンテンツの内容
+
+コンテンツの内容を記録します。変更前後の比較や、以前の状態を復元する際に利用できます。
+
+## 使い方
+
+SDKを使った履歴管理機能の使い方を説明します。
+
+### 履歴の取得
+
+履歴を取得するには、CMS SDKの `listHistory()` メソッドを使用します。
+
+```ts copy
+await cmsClient.tables.blog.listHistory(id);
+```
+
+以下のように履歴情報が取得できます。
+
+```json copy
+{
+  "contents": [
+    {
+      "id": 2,
+      "createdAt": "2025-01-02T00:00:00Z",
+      "action": "publish",
+      "developerAPI": false,
+      "managementAPI": true,
+      "consumerAPI": false,
+      "projectUserId": "M3h4U0OZkiCBiaI8",
+      "apiKey": null,
+      "content": {
+        "id": "GtWHkA8K90hBTXSk",
+        "title": "記事タイトル",
+        "body": "記事本文",
+        "group": null,
+        "scheduledPublishAt": null,
+        "scheduledUnpublishAt": null,
+        "_draft": false,
+        "_published": true,
+        "createdAt": "2025-01-01T00:00:00Z",
+        "updatedAt": "2025-01-02T00:00:00Z",
+        "publishedAt": "2025-01-02T00:00:00Z"
+      }
+    },
+    {
+      "id": 1,
+      "createdAt": "2025-01-01T00:00:00Z",
+      "action": "create",
+      "developerAPI": false,
+      "managementAPI": true,
+      "consumerAPI": false,
+      "projectUserId": "M3h4U0OZkiCBiaI8",
+      "apiKey": null,
+      "content": {
+        "id": "GtWHkA8K90hBTXSk",
+        "title": "記事タイトル（下書き）",
+        "body": "記事本文の下書き中です。",
+        "group": null,
+        "scheduledPublishAt": null,
+        "scheduledUnpublishAt": null,
+        "_draft": true,
+        "_published": false,
+        "createdAt": "2025-01-01T00:00:00Z",
+        "updatedAt": "2025-01-01T00:00:00Z",
+        "publishedAt": null
+      }
+    }
+  ],
+  "totalCount": 2
+}
+```
+
+デフォルトでは最新の10バージョンが取得できます。第二引数にオプションを指定することで、取得件数やページングの設定ができます。
+
+```ts copy
+await cmsClient.tables.blog.listHistory(id, { limit: 10, offset: 0 });
+```
+
+### コンテンツの復元
+
+コンテンツを復元するには、復元したいバージョンの `content` プロパティのデータでコンテンツを更新してください。
+
+```ts copy
+// 履歴を取得
+const { contents } = await cmsClient.tables.blog.listHistory(id);
+
+// 履歴から復元したいバージョンのデータを取得
+const { title, body } = contents[0].content;
+
+// コンテンツを更新
+await cmsClient.tables.blog.update(id, { title, body });
+```
+
+> [!WARNING]
+> 履歴では、記録時点のコンテンツをそのまま保持しています。そのためテーブルのカラム構成を変更している場合、過去と現在のデータ構造に互換性がない可能性があります。

package/dist/docs/features/schema/about.md

@@ -0,0 +1,215 @@
+<!-- source: docs/src/app/features/schema/about/page.mdx -->
+
+# スキーマとは
+
+スキーマは、プロジェクトの構成を定義する設定ファイルです。以下の要素で構成されます。
+
+- [**tables**](./database.md): データベースの定義
+- [**tableModules**](./table-module.md): データベースで複雑なデータ構造を表現するためのモジュールの定義
+- [**buckets**](./bucket.md): バケットの定義
+- [**authorities**](./authority.md): 権限の定義
+
+設定ファイルはTypeScriptで記述します。このファイルを Orizm CLI に読み込ませて使用します。通常、ファイル名は `orizm.config.ts` でプロジェクトルートに配置しますが、CLI のオプションで任意のファイル名や配置場所を指定できます。
+
+## スキーマの例
+
+以下はスキーマの例です。
+
+```ts copy filename="orizm.config.ts" showLineNumbers
+import { defineConfig } from "@orizm/cli/config";
+
+export default defineConfig({
+  tables: {
+    blog: {
+      columns: {
+        slug: {
+          type: "string",
+          required: true,
+        },
+        title: {
+          type: "string",
+          required: true,
+        },
+        tags: {
+          type: "module-array",
+          moduleName: "tag",
+        },
+        body: {
+          type: "string",
+        },
+      },
+      indexes: [{ columns: ["slug"], unique: true }],
+      enableDrafts: true,
+    },
+    tag: {
+      columns: {
+        key: {
+          type: "string",
+          required: true,
+        },
+        displayName: {
+          type: "string",
+          required: true,
+        },
+      },
+      indexes: [{ columns: ["key"], unique: true }],
+    },
+  },
+  tableModules: {
+    tag: {
+      columns: {
+        tagId: {
+          type: "reference",
+          tableName: "tag",
+          includeName: "tag",
+          onDelete: "cascade",
+        },
+      },
+    },
+  },
+  buckets: {
+    public: {
+      accessControl: "public",
+    },
+  },
+  authorities: [
+    {
+      match: { role: "editor" },
+      allowTables: ["blog", "category", "tag"],
+      allowBuckets: ["images"],
+      denyUserManagement: true,
+    },
+  ],
+});
+```
+
+## Orizm CLI
+
+Orizm CLI を使用してスキーマのバリデーションや適用、クライアントコードの生成を行うことができます。
+CLIは `@orizm/cli` パッケージに含まれています。
+
+詳細は [Orizm CLI](../cli.md) ページを参照してください。
+
+旧 CMS CLI や Consumer CLI を利用している場合は、[CLI移行ガイド](../../resources/cli-migration-guide.md) を参考に Orizm CLI への移行を行なってください。
+
+### スキーマのバリデーション
+
+Orizm CLI を使用してスキーマ定義のバリデーションを行うことができます。
+
+`schema validate` コマンドを実行すると、スキーマの定義が正しいかどうかを検証します。
+
+```sh copy
+orizm schema validate
+```
+
+### スキーマの適用
+
+プロジェクトにスキーマを適用するには、Orizm CLIを使用します。
+
+`schema push` コマンドでスキーマをプロジェクトに適用します。
+
+```sh copy
+orizm schema push
+```
+
+`codegen cms` コマンドでスキーマをもとにCMS向けのクライアントコードやTypeScriptの型定義を生成します。
+
+```sh copy
+orizm codegen cms
+```
+
+`codegen consumer` コマンドでスキーマをもとにConsumer向けのクライアントコードやTypeScriptの型定義を生成します。
+
+```sh copy
+orizm codegen consumer
+```
+
+## `defineConfig()` を使わない定義方法
+
+`@orizm/cli` バージョン 1.1.0 でスキーマ定義用のヘルパー関数 `defineConfig()` が追加されました。  
+それより前のバージョンの定義方法とは以下の違いがあります。
+
+- `tables`, `tableModules`, `buckets` プロパティはオブジェクトではなく、配列で定義していました。
+- `tables`, `tableModules` およびそのカラムと `buckets` は、名前をオブジェクトのキーではなく `name` プロパティで定義していました。
+
+以前の定義方法を使用している場合は、上記の変更に対応することで `defineConfig()` を使った定義方法へ移行できます。
+
+以下に以前の定義方法で書かれたスキーマを示します。
+
+```ts copy filename="orizm.config.ts" showLineNumbers
+import type { Orizm } from "@orizm/cms-sdk";
+
+export default {
+  tables: [
+    {
+      name: "blog",
+      columns: [
+        {
+          name: "slug",
+          type: "string",
+          required: true,
+        },
+        {
+          name: "title",
+          type: "string",
+          required: true,
+        },
+        {
+          name: "tags",
+          type: "module-array",
+          moduleName: "tag",
+        },
+        {
+          name: "body",
+          type: "string",
+        },
+      ],
+      indexes: [{ columns: ["slug"], unique: true }],
+      enableDrafts: true,
+    },
+    {
+      name: "tag",
+      columns: [
+        {
+          name: "key",
+          type: "string",
+          required: true,
+        },
+        {
+          name: "displayName",
+          type: "string",
+          required: true,
+        },
+      ],
+      indexes: [{ columns: ["key"], unique: true }],
+    },
+  ],
+  tableModules: [
+    {
+      name: "tag",
+      columns: [
+        {
+          name: "tagId",
+          type: "reference",
+          tableName: "tag",
+          includeName: "tag",
+          onDelete: "cascade",
+        },
+      ],
+    },
+  ],
+  buckets: [
+    {
+      name: "object",
+    },
+  ],
+  authorities: [
+    {
+      match: { role: "editor" },
+      allowTables: ["blog", "category", "tag"],
+      allowBuckets: ["images"],
+      denyUserManagement: true,
+    },
+  ],
+} satisfies Orizm.ProjectDefine;
+```