@orizm/cli 3.1.0 → 3.2.0

package/dist/docs/features/draft.md

@@ -0,0 +1,241 @@
+<!-- source: docs/src/app/features/draft/page.mdx -->
+
+# 下書き管理
+
+下書き管理機能を使用すると、コンテンツを公開前に下書きとして保存し、編集・確認してから公開できます。この機能はコンテンツの品質管理やワークフロー管理に役立ちます。
+
+以下の機能を提供します。
+
+- コンテンツを下書き状態で保存
+- コンテンツの公開ステータスを管理
+- 下書きと公開コンテンツを並行管理
+- 公開、非公開をスケジュール予約
+
+## ユースケース例
+
+### コンテンツの事前作成
+
+下書き管理機能を活用すれば、リリース情報やシステムメンテナンスなどの重要なお知らせを事前に準備し、指定日時に自動公開できます。
+
+### 期間限定コンテンツの管理
+
+下書き管理機能の公開・非公開スケジュール設定を組み合わせることで、季節的なキャンペーンやセール、イベント情報など、特定の期間だけ表示したいコンテンツを効率的に管理できます。
+
+1. 事前に下書きとしてコンテンツを作成
+1. キャンペーン開始日時に自動公開
+1. 終了日時に自動的に非公開
+1. 翌年も使用できるコンテンツは下書き状態で保存し、必要に応じて更新や複製して再利用
+
+### コンテンツの承認ワークフロー
+
+コンテンツ公開前に品質管理のための承認プロセスが必要な場合があります。下書き管理機能を使用すると、コンテンツ制作者とレビュワーが効率的に協働できるワークフローを構築できます。
+
+例えば企業ブログでは、マーケティングチームのライターが記事を下書きとして作成し、編集者や法務担当者がレビューします。修正が必要な場合は下書き状態のままコンテンツを更新できるため、公開サイトに影響を与えることなく何度でも編集可能です。承認が得られたら下書きコンテンツを公開できます。
+
+## 機能の有効化
+
+スキーマで [テーブル](./schema/database.md) ごとに有効化できます。`enableDrafts` プロパティを `true` に設定します。
+
+```ts copy filename="orizm.config.ts" showLineNumbers {7}
+import { defineConfig } from "@orizm/cli/config";
+
+export default defineConfig({
+  tables: {
+    blog: {
+      columns: {},
+      enableDrafts: true,
+    },
+  },
+});
+```
+
+## 予約カラム
+
+下書き管理機能を有効化すると、テーブルに予約カラムが追加されます。
+
+### \_draft
+
+コンテンツがドラフトかどうかを示すフラグです。
+
+`true` の場合は下書き、`false` の場合は公開コンテンツです。
+
+直接書き換えることはできません。
+
+### \_published
+
+コンテンツが公開中かどうかを示すフラグです。
+
+`true` の場合は公開中、`false` の場合は非公開です。公開されていれば下書きデータに対しても `true` になります。
+
+直接書き換えることはできません。
+
+### publishedAt
+
+コンテンツがはじめて公開状態になった日時です。
+
+ISO 8601 形式の文字列で構成されます。（例: `2025-01-01T00:00:00.000Z`）
+
+### scheduledPublishAt
+
+コンテンツを公開する予定の日時です。
+
+ISO 8601 形式の文字列で構成されます。（例: `2025-01-01T00:00:00.000Z`）
+
+このカラムに値を設定すると、指定した日時に自動で公開されます。
+
+### scheduledUnpublishAt
+
+コンテンツを非公開にする予定の日時です。
+
+ISO 8601 形式の文字列で構成されます。（例: `2025-01-01T00:00:00.000Z`）
+
+このカラムに値を設定すると、指定した日時に自動で非公開になります。
+
+## 使い方
+
+SDKを使った下書き管理機能の使い方を説明します。
+
+### コンテンツの作成
+
+コンテンツを作成するにはCMS SDKを使用します。
+
+下書きコンテンツとして作成するには `create()` の第二引数のオブジェクトに `draft: true` を指定します。
+
+```ts copy
+await cmsClient.tables.blog.create(content, { draft: true });
+```
+
+公開コンテンツとして作成するには `create()` の第二引数を省略するか、オブジェクトに `draft: false` を指定します。
+
+```ts copy
+await cmsClient.tables.blog.create(content);
+```
+
+### コンテンツの更新
+
+コンテンツを更新するにはCMS SDKを使用します。
+
+以下のケースでは `update()` の第三引数のオブジェクトに `draft: true` を指定します。
+
+- すでに公開されているコンテンツに下書きを作成したい
+- 下書きコンテンツを更新したい
+
+```ts copy
+await cmsClient.tables.blog.update(id, content, { draft: true });
+```
+
+公開コンテンツを更新するには `update()` の第三引数を省略するか、オブジェクトに `draft: false` を指定します。
+
+```ts copy
+await cmsClient.tables.blog.update(id, content);
+```
+
+> [!NOTE]
+> update()
+> では下書きコンテンツを更新しつつ、公開状態にすることはできません。代わりに、下書きコンテンツに対して
+> `publish()` を使用します。
+
+### 下書きの公開
+
+下書きコンテンツを公開するにはCMS SDKの `publish()` を使用します。
+
+```ts copy
+await cmsClient.tables.blog.publish(id);
+```
+
+第二引数にコンテンツのデータを渡すことで、更新と同時に公開することもできます。
+
+```ts copy
+await cmsClient.tables.blog.publish(id, content);
+```
+
+### コンテンツの非公開化
+
+コンテンツを非公開にするにはCMS SDKの `unpublish()` を使用します。
+
+```ts copy
+await cmsClient.tables.blog.unpublish(id);
+```
+
+### コンテンツの削除
+
+コンテンツを削除するにはCMS SDKを使用します。
+
+下書きコンテンツを削除するには `delete()` の第二引数のオブジェクトに `draft: true` を指定します。
+
+```ts copy
+await cmsClient.tables.blog.delete(id, { draft: true });
+```
+
+コンテンツを完全に削除するには `delete()` の第二引数を省略するか、オブジェクトに `draft: false` を指定します。
+
+```ts copy
+await cmsClient.tables.blog.delete(id);
+```
+
+### コンテンツの取得
+
+コンテンツを取得するにはCMSではCMS SDKを使用します。ConsumerではConsumer SDKを使用します。
+
+#### CMS SDK
+
+CMS SDKでは以下のメソッドで下書きコンテンツの取得が可能です。
+
+- **`get()`**: 第二引数で `draft: true` を指定
+- **`getByUnique()`**: `get()` と同様に第二引数で `draft: true` を指定
+- **`list()`**: 第一引数で `draft: true` を指定
+
+CMS SDKでは特に指定しなくても `draft: true` がデフォルトです。
+
+```ts copy
+await cmsClient.tables.blog.get(id, { draft: true });
+await cmsClient.tables.blog.getByUnique({ slug: "example" }, { draft: true });
+await cmsClient.tables.blog.list({ draft: true });
+```
+
+#### Consumer SDK
+
+Consumer SDKでは以下のメソッドで下書きコンテンツの取得が可能です。
+
+- **`get()`**: 第二引数で `draft: true` を指定
+- **`getByUnique()`**: `get()` と同様に第二引数で `draft: true` を指定
+- **`list()`**: 第一引数で `draft: true` を指定
+
+Consumer SDKで下書きコンテンツを取得するには `draft: true` を指定する必要があります。
+
+```ts copy
+await consumerClient.tables.blog.get(id, { draft: true });
+await consumerClient.tables.blog.getByUnique(
+  { slug: "example" },
+  { draft: true },
+);
+await consumerClient.tables.blog.list({ draft: true });
+```
+
+### 下書きコンテンツの公開予約
+
+下書きコンテンツを公開予約するにはCMS SDKの `update()` で下書きデータに対して、`scheduledPublishAt` に公開予約日時を設定します。
+
+```ts copy
+await cmsClient.tables.blog.update(
+  id,
+  {
+    scheduledPublishAt: "2025-01-01T00:00:00.000Z",
+  },
+  { draft: true },
+);
+```
+
+公開処理が完了すると `scheduledPublishAt` に設定されていた値はクリアされます。
+
+### 公開コンテンツの非公開予約
+
+公開コンテンツを非公開予約するにはCMS SDKの `update()` で公開データに対して、`scheduledUnpublishAt` に非公開予約日時を設定します。
+
+```ts copy
+await cmsClient.tables.blog.update(id, {
+  scheduledUnpublishAt: "2025-01-01T00:00:00.000Z",
+});
+```
+
+非公開処理が完了すると `scheduledUnpublishAt` に設定されていた値はクリアされます。

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

@@ -0,0 +1,83 @@
+<!-- source: docs/src/app/features/form/about/page.mdx -->
+
+# フォーム管理の概要
+
+フォーム管理機能を使用すると、WEBサイトにお問い合わせや資料請求などのフォームを簡単に設置できます。フォームの設定やデザインをカスタマイズし、送信されたデータを管理できます。
+
+以下の特徴があります。
+
+- Webサイトにフォームを設置
+- [フォームエディター](./editor.md) で構成を直感的に編集
+- フォームのデザインをカスタマイズ可能
+- フォームから送信されたデータを管理
+
+## 機能の有効化
+
+スキーマで [テーブル](../schema/database.md) ごとに有効化できます。`enableForm` プロパティを `true` に設定します。`formOptions` プロパティでフォームのオプション設定ができます。
+
+```ts copy filename="orizm.config.ts" showLineNumbers {21-34}
+import { defineConfig } from "@orizm/cli/config";
+
+export default defineConfig({
+  tables: {
+    form: {
+      columns: {
+        key: {
+          type: "string",
+          required: true,
+          pattern: "^[0-9a-z-]+$",
+        },
+        displayName: {
+          type: "string",
+          required: true,
+        },
+        body: {
+          type: "json",
+        },
+      },
+      indexes: [{ columns: ["key"], unique: true }],
+      enableForm: true,
+      formOptions: {
+        submissionColumns: {
+          status: {
+            type: "string",
+            pattern: /^(open|in_progress|closed|trashed)$/,
+            default: "open",
+            required: true,
+          },
+          memo: {
+            type: "string",
+          },
+        },
+      },
+    },
+  },
+});
+```
+
+この `form` テーブルには、フォームに関するメタデータを保存します。`key` カラムにはフォームを特定するための一意なキーを設定し、`body` カラムにはフォームの構造をJSON形式で保存します。
+
+### submissionColumns
+
+フォーム機能では、フォームから送信されたデータ（以下、受信データ）も管理できます。これを利用してCMSに受信箱機能を実装できます。
+
+`formOptions.submissionColumns` で受信箱に任意のカラムを追加できます。先の例では、受信データを管理するための `status` と `memo` カラムを追加しています。
+
+- **statusカラム**: 受信データのステータスを保存する
+- **memoカラム**: 受信データに対するメモを保存する
+
+## 予約カラム
+
+フォーム管理機能を有効化すると、テーブルに予約カラムが追加されます。
+
+### formSchema
+
+フォームの項目やバリデーションルールなどのスキーマです。JSON形式で保存されます。
+
+[フォームエディター](./editor.md) と組み合わせて使用します。
+
+## 次のステップ
+
+フォーム管理機能を使うには、フォームエディターを導入する必要があります。次のステップでは、フォームエディターの導入方法と実装方法を説明します。
+
+- [フォームエディター](./editor.md)