Component Zod Pull

Получайте описание ваших компонентов в формате Zod во время компиляции с помощью скрипта

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

https://zod.dev

Чтобы забрать нашу схему 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.

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

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