Component Zod Pull

Отримуйте опис ваших компонентів у форматі zod під час компіляції за допомогою скрипту

Ця функція дозволяє отримати опис компонента у вигляді типобезпечного опису «Zod», який забезпечує перевірку схем із пріоритетом TS та статичне виведення типів для вашого контенту.

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