Быстрый старт

Генерация типобезопасных схем 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 is not set. Set it in your environment or .env file.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID is not set. Set it in your environment or .env file.'
    );
  }

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

  console.log('[generate-schemas] Done.');
}

main().catch((err) => {
  console.error('[generate-schemas] Failed:', 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] Done.

Обновленная структура проекта

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

• Вы можете интегрировать это в свой рабочий процесс разработки или сборки
• Обновляйте схемы через административную панель, затем регенерируйте их локально