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

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

Генерация типобезопасных схем 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`