Schnellstart

Typensichere Zod-Schemata generieren

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

• TypeScript-zentrierte Schemavalidierung
• Statische Typinferenz

Mehr erfahren: https://zod.dev

Einrichtung

Um Ihr Zod-Schema abzurufen, werden Sie:

1. Die erforderlichen Abhängigkeiten laden
2. Ein Skript mithilfe der Utilities aus cms-renderer erstellen

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 } = cmsConfig;

  if (!cmsUrl) {
    throw new Error(
      '[generate-schemas] NEXT_PUBLIC_CMS_API_URL is not set. Set it in your environment or .env file.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID is not set. Set it in your environment or .env file.'
    );
  }

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

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

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

Beispiel für die CMS-Konfiguration

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

Konfiguration von package.json

Hinweis: Wenn Sie keine tsconfig.json haben, entfernen Sie den --tsconfig-Schalter.

{
  "name": "web",
  "version": "0.1.0",
  "type": "module",
  "private": true,
  "scripts": {
    "generate-schemas": "tsx --tsconfig tsconfig.json scripts/generate-schemas.ts",
    "...": "..."
  },
  "dependencies": {

Ausführen des Skripts

bun run generate-schemas

Beispielausgabe:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] Done.

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 Ihre Schemastruktur zu verstehen
• Führen Sie das Skript erneut aus, sobald sich Ihr Schema ändert:

bun run generate-schemas

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