profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsТипове компонентиSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyСкриптове в конструктора на шаблониProject ScaffoldingМедийна библиотека

Без глава

Бърз стартSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Преглед на REST APIgetСвързване на уебсайт към CMS APIgetGET /routesgetGET /routegetGET /blocksgetВземане на блокове с CEL кешgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postПревод на публикацияpatchPATCH /translationsgetПолучаване на използванетоpostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

Бърз старт

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

Създайте типово-сигурни Zod схеми

Тази функционалност ви позволява да получите описанието на вашите компоненти под формата на типово сигурна Zod схема, като осигурява:

  • Валидиране на схемата с приоритет TypeScript
  • Статично извеждане на типове

Научете повече: https://zod.dev

Настройка

За да изтеглите своята Zod схема, трябва да:

  1. Заредите необходимите зависимости
  2. Създадете скрипт, използвайки помощните функции от 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
  • Можете да интегрирате това във вашия процес на разработка или билд
  • Актуализирайте компонентите чрез администраторския панел и след това ги генерирайте отново локално
Continue Reading
NextSplit Screen JSON Component Builder with LLM›