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 proxySkripting i malbyggerenProject ScaffoldingMedia Library

Headless

Quick startSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postEtteroversettelsepatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

Quick start

Et innlegg om skjemaer

Generer typesikre Zod-skjemaer

Denne funksjonen lar deg hente komponentbeskrivelsen din i form av et typesikkert Zod-skjema, og tilbyr:

  • Skjemavalidering med TypeScript i fokus
  • Statisk typeinferens

Lær mer: https://zod.dev

Oppsett

For å hente Zod-skjemaet ditt må du:

  1. Last inn nødvendige avhengigheter
  2. Lag et skript ved å bruke verktøyene fra cms-renderer

Prosjektstruktur

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

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 er ikke satt. Angi den i miljøet ditt eller .env-filen.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID er ikke satt. Angi den i miljøet ditt eller .env-filen.'
    );
  }

  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY er ikke satt. Angi den i miljøet ditt eller .env-filen.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] Ingen komponenter returnert fra API-et. Kontroller at PROFOUND_API_KEY er gyldig og peker til riktig nettsted.'
    );
  }

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

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

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

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

Eksempel på CMS-konfigurasjon

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

Konfigurasjon for package.json

Merk: Hvis du ikke har en tsconfig.json, fjern --tsconfig-flagget.

{
  "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",
    "...": "..."
  }
}

Kjøre skriptet

bun run generate-schemas

Eksempelutdata:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] Fant 3 komponenter: post, categories, header
[generate-schemas] Ferdig.

Oppdatert prosjektstruktur

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

Bruk i page.tsx

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

// Bruk for typesikker parsing
petFoodPostSchema.parse(obj);

Merknader

  • Undersøk den genererte filen for å forstå strukturen til komponenten din
  • Kjør skriptet på nytt hver gang strukturen til komponenten din endres:
bun run generate-schemas
  • Du kan integrere dette i utviklings- eller byggeflyten din
  • Oppdater komponenter via administrasjonspanelet, og generer deretter på nytt lokalt
Continue Reading
NextSplit Screen JSON Component Builder with LLM›