Component Zod Pull

スクリプトを使用してコンパイル時にコンポーネントの Zod 記述を取得します

この機能を使用すると、コンポーネントの説明を型安全な「Zod」記述として取得でき、コンテンツに対して TS ファーストのスキーマ検証と静的型推論を提供します。

Zod スキーマを取得するために、いくつかの依存関係を読み込み、cms-renderer のユーティリティを利用するスクリプトを作成します。

まずはプロジェクト構成から始めましょう

apps/
 web/
 app/
   page.tsx
 scripts/
   generate-schemas.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, apiKey } = cmsConfig;

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

  const schemas = await fetchAllCustomSchemaFields({ cmsUrl, websiteId, apiKey });

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] API からコンポーネントが返されませんでした。PROFOUND_API_KEY が有効で、正しいウェブサイトを指しているか確認してください。'
    );
  }

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

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

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

CmsConfig は次のようになります

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

package.json の中で、スクリプトの実行方法といくつかの依存関係を定義します

注意: tsconfig がない場合は、--tsconfig フラグとその値を削除できます

{
  "name": "web",
  "version": "0.1.0",
  "type": "module",
  "private": true,
  "scripts": {
    "generate-schemas": "tsx --tsconfig tsconfig.json scripts/generate-schemas.ts",
    "...": "..."
  },
  "dependencies": {
    "cms-renderer": "0.3.1",
    "zod": "^4.3.6",
    "...": "..."
  },
  "devDependencies": {
    "tsx": "^4.21.0",
    "object-hash": "^3.0.0",
    "...": "..."
  }
}

さて、次を実行すると

$ 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-schema.ts // 生成された Zod スキーマ

中身を確認してスキーマがどのようになっているかを確認できます。このファイルを更新するには、bun run generate-schemas コマンドを再実行する必要があり、dev や build のワークフローに組み込むこともできます。

page.tsx ファイルにこれらの Zod オブジェクトを次のように取り込めます

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

// 型安全なオブジェクト解析には petFoodPostSchema.parse(obj) を呼び出します

管理画面からコンポーネントを更新し、更新されたスキーマを再取得することでスムーズに開発できます

Previous‹Split Screen JSON Component Builder with LLM