Швидкий старт

Публікація про схеми

Генеруйте типобезпечні схеми Zod

Ця функція дозволяє отримати опис ваших компонентів у вигляді типобезпечної схеми Zod, що забезпечує:

перевірку схем із пріоритетом TypeScript
статичне виведення типів

Дізнайтеся більше: https://zod.dev

Налаштування

Щоб отримати вашу схему Zod, потрібно:

Завантажити необхідні залежності
Створити скрипт, використовуючи утиліти з 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, apiKey } = cmsConfig;

  if (!cmsUrl) {
    throw new Error(
      '[generate-schemas] NEXT_PUBLIC_CMS_API_URL не встановлено. Задайте його у своїх змінних середовища або у файлі .env.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_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 дійсний і вказує на потрібний вебсайт.'
    );
  }

  console.log(
    `[generate-schemas] Знайдено ${schemas.length} компонентів: ${schemas.map((s) => s.name).join(', ')}`
  );

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

  console.log('[generate-schemas] Виконано.');
}

main().catch((err) => {
  console.error('[generate-schemas] Помилка:', 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": {
    "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] Знайдено 3 компоненти: post, categories, header
[generate-schemas] Виконано.

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

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

Ви можете інтегрувати це у свій процес розробки або збірки
Оновіть компоненти через адмін-панель, а потім згенеруйте їх локально заново

NextSplit Screen JSON Component Builder with LLM›

Швидкий старт

Публікація про схеми

Генеруйте типобезпечні схеми Zod

Ця функція дозволяє отримати опис ваших компонентів у вигляді типобезпечної схеми Zod, що забезпечує:

перевірку схем із пріоритетом TypeScript
статичне виведення типів

Дізнайтеся більше: https://zod.dev

Налаштування

Щоб отримати вашу схему Zod, потрібно:

Завантажити необхідні залежності
Створити скрипт, використовуючи утиліти з 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, apiKey } = cmsConfig;

  if (!cmsUrl) {
    throw new Error(
      '[generate-schemas] NEXT_PUBLIC_CMS_API_URL не встановлено. Задайте його у своїх змінних середовища або у файлі .env.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_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 дійсний і вказує на потрібний вебсайт.'
    );
  }

  console.log(
    `[generate-schemas] Знайдено ${schemas.length} компонентів: ${schemas.map((s) => s.name).join(', ')}`
  );

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

  console.log('[generate-schemas] Виконано.');
}

main().catch((err) => {
  console.error('[generate-schemas] Помилка:', 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": {
    "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] Знайдено 3 компоненти: post, categories, header
[generate-schemas] Виконано.

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

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

Ви можете інтегрувати це у свій процес розробки або збірки
Оновіть компоненти через адмін-панель, а потім згенеруйте їх локально заново

NextSplit Screen JSON Component Builder with LLM›

Швидкий старт

Генеруйте типобезпечні схеми Zod

Налаштування

Структура проєкту

Скрипт: generated-schema.ts

Приклад конфігурації CMS

Конфігурація package.json

Запуск скрипту

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

Використання у page.tsx

Примітки

Швидкий старт

Генеруйте типобезпечні схеми Zod

Налаштування

Структура проєкту

Скрипт: generated-schema.ts

Приклад конфігурації CMS

Конфігурація package.json

Запуск скрипту

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

Використання у page.tsx

Примітки

Скрипт: `generated-schema.ts`

Конфігурація `package.json`

Використання у `page.tsx`

Скрипт: `generated-schema.ts`

Конфігурація `package.json`

Використання у `page.tsx`