クイックスタート

型安全な Zod スキーマを生成する

この機能を使用すると、スキーマの定義を型安全な Zod スキーマの形式で取得でき、次の利点があります。

• TypeScript を第一としたスキーマ検証
• 静的な型推論

詳細はこちら: https://zod.dev

セットアップ

Zod スキーマを取得するには、次の手順を実行します。

1. 必要な依存関係を読み込む
2. cms-renderer のユーティリティを使用してスクリプトを作成する

プロジェクト構成

apps/
  web/
    app/
      page.tsx
    scripts/
      generated-schema.ts   # スクリプトファイル

スクリプト: generated-schema.ts

import { fetchAllCustomSchemaFields, saveZodSchemaCode } from 'cms-renderer/lib/custom-schemas';
import { cmsConfig } from '../lib/cms-config';

async function main() {
  const { cmsUrl, websiteId } = cmsConfig;

  if (!cmsUrl) {
    throw new Error(
      '[generate-schemas] NEXT_PUBLIC_CMS_API_URL が設定されていません。環境または .env ファイルで設定してください。'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID が設定されていません。環境または .env ファイルで設定してください。'
    );
  }

  await saveZodSchemaCode(
    await fetchAllCustomSchemaFields(cmsConfig),
    './generated/cms-schemas.ts'
  );

  console.log('[generate-schemas] 完了しました。');
}

main().catch((err) => {
  console.error('[generate-schemas] 失敗しました:', err);
  process.exit(1);
});

CMS 設定例

export const cmsConfig = {
  cmsUrl: process.env.NEXT_PUBLIC_CMS_API_URL,
  apiKey: process.env.CMS_API_KEY,
  websiteId: '...',
};

package.json の設定

注意: tsconfig.json がない場合は、--tsconfig フラグを削除してください。

{
  "name": "web",
  "version": "0.1.0",
  "type": "module",
  "private": true,
  "scripts": {
    "generate-schemas": "tsx --tsconfig tsconfig.json scripts/generate-schemas.ts",
    "...": "..."
  },
  "dependencies": {

スクリプトの実行

bun run generate-schemas

出力例:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] 完了しました。

更新後のプロジェクト構成

apps/
  web/
    app/
      page.tsx
    scripts/
      generated-schema.ts
    generated/
      cms-schemas.ts   # 生成された Zod スキーマ

page.tsx での使用方法

import type { PetFoodPost, SiteConfig } from '@/generated/cms-schemas';
import { petFoodPostSchema } from '@/generated/cms-schemas';

// 型安全なパースに使用する
petFoodPostSchema.parse(obj);

注意事項

• スキーマ構造を把握するために、生成されたファイルを確認する
• スキーマが変更されたら、その都度スクリプトを再実行する:

bun run generate-schemas

• 開発またはビルドのワークフローに統合できる
• 管理パネルからスキーマを更新し、ローカルで再生成する