profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Parametrično usmerjanjeTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyPisanje skript v graditelju predlogProject ScaffoldingMedijska knjižnica

Brez glave

Hitri začetekSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Pregled REST API-jagetPovezava spletnega mesta z API-jemgetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPrevajanje objavepatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

Hitri začetek

Objava o shemah

Generirajte tipovno varne sheme Zod

Ta funkcija vam omogoča, da dobite opis svojih komponent v obliki tipovno varne sheme Zod, ki zagotavlja:

  • Validacijo shem s poudarkom na TypeScript
  • Statično sklepanje tipov

Več izveste: https://zod.dev

Nastavitev

Da pridobite svojo shemo Zod, boste:

  1. Naložili zahtevane odvisnosti
  2. Ustvarili skript z uporabo pripomočkov iz cms-renderer

Struktura projekta

apps/
  web/
    app/
      page.tsx
    scripts/
      generated-schema.ts   # datoteka skripta

Skript: 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 ni nastavljen. Nastavite ga v svojem okolju ali datoteki .env.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID ni nastavljen. Nastavite ga v svojem okolju ali datoteki .env.'
    );
  }

  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY ni nastavljen. Nastavite ga v svojem okolju ali datoteki .env.'
    );
  }

  const schemas = await fetchAllCustomSchemaFields({ cmsUrl, websiteId, apiKey });

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] API ni vrnil nobenih komponent. Preverite, ali je PROFOUND_API_KEY veljaven in kaže na pravo spletno mesto.'
    );
  }

  console.log(
    `[generate-schemas] Najdenih ${schemas.length} komponent: ${schemas.map((s) => s.name).join(', ')}`
  );

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

  console.log('[generate-schemas] Končano.');
}

main().catch((err) => {
  console.error('[generate-schemas] Ni uspelo:', err);
  process.exit(1);
});

Primer konfiguracije CMS

export const cmsConfig = {
  cmsUrl: process.env.NEXT_PUBLIC_CMS_API_URL,
  apiKey: process.env.CMS_API_KEY,
  websiteId: '...',
};

Konfiguracija package.json

Opomba: Če nimate tsconfig.json, odstranite zastavico --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",
    "...": "..."
  }
}

Zagon skripta

bun run generate-schemas

Primer izpisa:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] Najdene 3 komponente: post, categories, header
[generate-schemas] Končano.

Posodobljena struktura projekta

apps/
  web/
    app/
      page.tsx
    scripts/
      generated-schema.ts
    generated/
      cms-schemas.ts   # generirana shema Zod

Uporaba v page.tsx

import type { PetFoodPost, SiteConfig } from '@/generated/cms-schemas';
import { petFoodPostSchema } from '@/generated/cms-schemas';

// Uporabite za tipovno varno razčlenjevanje
petFoodPostSchema.parse(obj);

Opombe

  • Preglejte generirano datoteko, da boste razumeli strukturo svoje komponente
  • Skript ponovno zaženite, kadar koli se spremeni struktura vaše komponente:
bun run generate-schemas
  • To lahko vključite v svoj razvojni ali graditveni potek dela
  • Komponente posodobite prek skrbniške nadzorne plošče, nato jih znova generirajte lokalno
Continue Reading
NextSplit Screen JSON Component Builder with LLM›