Component Zod Pull

Hole dir mithilfe eines Skripts zur Kompilierzeit die Zod-Beschreibung deiner Komponenten

Diese Funktion ermöglicht es dir, die Beschreibung deiner Komponente in Form einer typsicheren „Zod“-Beschreibung zu erhalten, die eine auf TypeScript ausgerichtete Schema-Validierung und statische Typinferenz für deine Inhalte bietet.

https://zod.dev

Um unser Zod-Schema abzurufen, werden wir einige Abhängigkeiten laden und ein Skript erstellen, das einige Utilities aus unserem cms-renderer verwendet.

Beginnen wir mit unserer Projektstruktur

apps/
 web/
 app/
   page.tsx
 scripts/
   generate-schemas.ts // hier befindet sich unser Skript

Jetzt bearbeiten wir diese Datei generated-schema.ts

import { fetchAllCustomSchemaFields, saveZodSchemaCode } from 'cms-renderer/lib/custom-schemas';
import { cmsConfig } from '../lib/cms-config'; // ich importiere meine Konfiguration

async function main() {
  const { cmsUrl, websiteId, apiKey } = cmsConfig;

  if (!cmsUrl) {
    throw new Error(
      '[generate-schemas] NEXT_PUBLIC_CMS_API_URL ist nicht gesetzt. Lege sie in deiner Umgebung oder der .env-Datei fest.'
    );
  }
  if (!websiteId) {
    throw new Error(
      '[generate-schemas] NEXT_PUBLIC_PROFOUND_WEBSITE_ID ist nicht gesetzt. Lege sie in deiner Umgebung oder der .env-Datei fest.'
    );
  }
  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY ist nicht gesetzt. Lege sie in deiner Umgebung oder der .env-Datei fest.'
    );
  }

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

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

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

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

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

Deine CmsConfig sollte wie folgt aussehen

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

In unserer package.json definieren wir, wie das Skript ausgeführt wird, sowie einige Abhängigkeiten

HINWEIS: Wenn du keine tsconfig hast, kannst du den --tsconfig-Schalter und seinen Wert entfernen

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

Nachdem wir nun Folgendes ausführen

$ bun run generate-schemas
tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] Erledigt.

sollten wir eine ähnliche Ausgabe erhalten, und wir sehen eine neue Datei in unserer Projektstruktur

apps/
 web/
 app/
   page.tsx
 scripts/
   generated-schema.ts // hier befindet sich unser Skript
 generated/
   cms-schema.ts // generiertes Zod-Schema

Du kannst hineinschauen und dir ansehen, wie dein Schema aussieht. Um diese Datei zu aktualisieren, musst du den Befehl bun run generate-schemas erneut ausführen, den du mit deinem dev- oder build-Workflow verbinden kannst.

Wir können diese Zod-Objekte dann in unsere Datei page.tsx importieren, und zwar so

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

// rufe petFoodPostSchema.parse(obj) auf, um Objekte typsicher zu parsen

Du kannst deine Komponente im Admin-Panel aktualisieren und das aktualisierte Schema erneut abrufen, um die Entwicklung zu vereinfachen.

Previous‹Split Screen JSON Component Builder with LLM