Schnellstart

Ein Beitrag über Schemata

Typensichere Zod-Schemas generieren

Diese Funktion ermöglicht es Ihnen, die Beschreibung Ihrer Komponenten in Form eines typensicheren Zod-Schemas zu erhalten und bietet:

Schema-Validierung mit TypeScript im Fokus
Statische Typherleitung

Mehr erfahren: https://zod.dev

Einrichtung

Um Ihr Zod-Schema abzurufen, führen Sie Folgendes aus:

Erforderliche Abhängigkeiten laden
Ein Skript erstellen, das Hilfsfunktionen aus cms-renderer nutzt

Projektstruktur

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

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 ist nicht gesetzt. Tragen Sie den Wert in Ihrer Umgebung oder der .env-Datei ein.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID ist nicht gesetzt. Tragen Sie den Wert in Ihrer Umgebung oder der .env-Datei ein.'
    );
  }

  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY ist nicht gesetzt. Tragen Sie den Wert in Ihrer Umgebung oder der .env-Datei ein.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] Keine Komponenten von der API zurückgegeben. Prüfen Sie, ob PROFOUND_API_KEY gültig ist und auf die richtige Website verweist.'
    );
  }

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

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

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

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

Beispiel für CMS-Konfiguration

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

`package.json`-Konfiguration

Hinweis: Wenn Sie keine tsconfig.json haben, entfernen Sie das Flag --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",
    "...": "..."
  }
}

Skript ausführen

bun run generate-schemas

Beispielausgabe:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] 3 Komponenten gefunden: post, categories, header
[generate-schemas] Fertig.

Aktualisierte Projektstruktur

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

Verwendung in `page.tsx`

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

// Für typensicheres Parsen verwenden
petFoodPostSchema.parse(obj);

Hinweise

Untersuchen Sie die generierte Datei, um die Struktur Ihrer Komponente zu verstehen
Führen Sie das Skript erneut aus, wann immer sich die Struktur Ihrer Komponente ändert:

bun run generate-schemas

Sie können dies in Ihren Entwicklungs- oder Build-Workflow integrieren
Aktualisieren Sie Komponenten über das Admin-Panel und generieren Sie sie anschließend lokal neu

NextSplit Screen JSON Component Builder with LLM›

Schnellstart

Ein Beitrag über Schemata

Typensichere Zod-Schemas generieren

Diese Funktion ermöglicht es Ihnen, die Beschreibung Ihrer Komponenten in Form eines typensicheren Zod-Schemas zu erhalten und bietet:

Schema-Validierung mit TypeScript im Fokus
Statische Typherleitung

Mehr erfahren: https://zod.dev

Einrichtung

Um Ihr Zod-Schema abzurufen, führen Sie Folgendes aus:

Erforderliche Abhängigkeiten laden
Ein Skript erstellen, das Hilfsfunktionen aus cms-renderer nutzt

Projektstruktur

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

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 ist nicht gesetzt. Tragen Sie den Wert in Ihrer Umgebung oder der .env-Datei ein.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID ist nicht gesetzt. Tragen Sie den Wert in Ihrer Umgebung oder der .env-Datei ein.'
    );
  }

  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY ist nicht gesetzt. Tragen Sie den Wert in Ihrer Umgebung oder der .env-Datei ein.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] Keine Komponenten von der API zurückgegeben. Prüfen Sie, ob PROFOUND_API_KEY gültig ist und auf die richtige Website verweist.'
    );
  }

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

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

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

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

Beispiel für CMS-Konfiguration

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

`package.json`-Konfiguration

Hinweis: Wenn Sie keine tsconfig.json haben, entfernen Sie das Flag --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",
    "...": "..."
  }
}

Skript ausführen

bun run generate-schemas

Beispielausgabe:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] 3 Komponenten gefunden: post, categories, header
[generate-schemas] Fertig.

Aktualisierte Projektstruktur

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

Verwendung in `page.tsx`

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

// Für typensicheres Parsen verwenden
petFoodPostSchema.parse(obj);

Hinweise

Untersuchen Sie die generierte Datei, um die Struktur Ihrer Komponente zu verstehen
Führen Sie das Skript erneut aus, wann immer sich die Struktur Ihrer Komponente ändert:

bun run generate-schemas

Sie können dies in Ihren Entwicklungs- oder Build-Workflow integrieren
Aktualisieren Sie Komponenten über das Admin-Panel und generieren Sie sie anschließend lokal neu

NextSplit Screen JSON Component Builder with LLM›

Schnellstart

Typensichere Zod-Schemas generieren

Einrichtung

Projektstruktur

Skript: generated-schema.ts

Beispiel für CMS-Konfiguration

package.json-Konfiguration

Skript ausführen

Aktualisierte Projektstruktur

Verwendung in page.tsx

Hinweise

Schnellstart

Typensichere Zod-Schemas generieren

Einrichtung

Projektstruktur

Skript: generated-schema.ts

Beispiel für CMS-Konfiguration

package.json-Konfiguration

Skript ausführen

Aktualisierte Projektstruktur

Verwendung in page.tsx

Hinweise

Skript: `generated-schema.ts`

`package.json`-Konfiguration

Verwendung in `page.tsx`

Skript: `generated-schema.ts`

`package.json`-Konfiguration

Verwendung in `page.tsx`