documentation

Эта функция позволяет получить описание вашей схемы в виде безопасного по типам описания «Zod», которое обеспечивает ориентированную на TypeScript валидацию схемы и статический вывод типов для вашей схемы.

https://zod.dev

Чтобы получить нашу схему Zod, мы загрузим несколько зависимостей и создадим скрипт, который использует некоторые утилиты из нашего cms-renderer.

Начнём со структуры проекта

theme={null}
apps/
 web/
 app/
   page.tsx
 scripts/
   generated-schema.ts // здесь находится наш скрипт

Теперь отредактируем файл generated-schema.ts

generated-schema.ts theme={null}
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);
});

Ваш CmsConfig должен выглядеть так

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

В файле package.json мы определяем, как запускать скрипт, и некоторые зависимости.

ПРИМЕЧАНИЕ: если у вас нет tsconfig, вы можете удалить флаг --tsconfig и его значение.

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

Теперь после запуска

$ bun run generate-schemas
tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] Done.

Мы должны получить похожий вывод и увидеть новый файл в структуре проекта.

theme={null}
apps/
 web/
 app/
   page.tsx
 scripts/
   generated-schema.ts // здесь находится наш скрипт
 generated/
   cms-schema.ts // сгенерированная схема zod

Вы можете открыть его и посмотреть, как выглядит ваша схема. Чтобы обновить этот файл, необходимо снова выполнить команду bun run generate-schemas, которую можно привязать к рабочему процессу dev или build.

Затем можно импортировать эти объекты Zod в файл page.tsx следующим образом

page.tsx theme={null}
import type { PetFoodPost, SiteConfig } from '@/generated/cms-schemas';
import { petFoodPostSchema } from '@/generated/cms-schemas';

// вызывайте petFoodPostSchema.parse(obj) для безопасного по типам разбора объектов

Вы можете обновить схему в админ-панели и снова подтянуть обновлённую схему для удобной разработки.

Компонент Zod Pull