profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyPisanje skripti u alatu za izradu predložakaProject ScaffoldingMedia Library

Bez sučelja

Brzi početakSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Pregled REST API-jagetPovezivanje web-stranice s CMS 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}postPrijevod objavepatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

Brzi početak

Objava o shemama

Generirajte tip-sigurne Zod sheme

Ova značajka omogućuje da dobijete opis svojih komponenti u obliku tip-sigurne Zod sheme, koja pruža:

  • Validaciju sheme prvenstveno usmjerenu na TypeScript
  • Statičko izvođenje tipova

Saznajte više: https://zod.dev

Postavljanje

Da biste preuzeli svoju Zod shemu, napravit ćete sljedeće:

  1. Učitajte potrebne ovisnosti
  2. Izradite skriptu koristeći pomoćne alate iz cms-renderer

Struktura projekta

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

Skripta: 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 nije postavljen. Postavite ga u svom okruženju ili u .env datoteci.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID nije postavljen. Postavite ga u svom okruženju ili u .env datoteci.'
    );
  }

  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY nije postavljen. Postavite ga u svom okruženju ili u .env datoteci.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] API nije vratio nijednu komponentu. Provjerite je li PROFOUND_API_KEY valjan i upućuje na odgovarajuću web-stranicu.'
    );
  }

  console.log(
    `[generate-schemas] Pronađeno je ${schemas.length} komponenti: ${schemas.map((s) => s.name).join(', ')}`
  );

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

  console.log('[generate-schemas] Gotovo.');
}

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

Primjer CMS konfiguracije

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

Konfiguracija package.json

Napomena: Ako nemate tsconfig.json, uklonite zastavicu --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",
    "...": "..."
  }
}

Pokretanje skripte

bun run generate-schemas

Primjer izlaza:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] Pronađene su 3 komponente: post, categories, header
[generate-schemas] Gotovo.

Ažurirana struktura projekta

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

Upotreba u page.tsx

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

// Koristite za tip-sigurno parsiranje
petFoodPostSchema.parse(obj);

Napomene

  • Pregledajte generiranu datoteku kako biste razumjeli strukturu svoje komponente
  • Ponovno pokrenite skriptu kad god se struktura vaše komponente promijeni:
bun run generate-schemas
  • Možete to integrirati u svoj razvojni ili build tijek rada
  • Ažurirajte komponente putem administratorske ploče, a zatim ponovno generirajte lokalno
Continue Reading
NextSplit Screen JSON Component Builder with LLM›