Component Zod Pull

Récupérez la description Zod de vos composants au moment de la compilation à l’aide d’un script

Cette fonctionnalité vous permet d’obtenir la description de votre composant sous la forme d’une description « Zod » à typage sûr, qui fournit une validation de schéma axée sur TypeScript (TS-first) et une inférence de type statique pour votre contenu.

https://zod.dev

Pour récupérer notre schéma Zod, nous allons charger quelques dépendances et créer un script qui utilise quelques utilitaires de notre cms-renderer.

Commençons par la structure de notre projet

apps/
 web/
 app/
   page.tsx
 scripts/
   generate-schemas.ts // c’est là que réside notre script

Nous allons maintenant modifier ce fichier generated-schema.ts

import { fetchAllCustomSchemaFields, saveZodSchemaCode } from 'cms-renderer/lib/custom-schemas';
import { cmsConfig } from '../lib/cms-config'; // j’importe ma configuration

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

  if (!cmsUrl) {
    throw new Error(
      '[generate-schemas] NEXT_PUBLIC_CMS_API_URL n’est pas défini. Définissez-le dans votre environnement ou votre fichier .env.'
    );
  }
  if (!websiteId) {
    throw new Error(
      '[generate-schemas] NEXT_PUBLIC_PROFOUND_WEBSITE_ID n’est pas défini. Définissez-le dans votre environnement ou votre fichier .env.'
    );
  }
  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY n’est pas défini. Définissez-le dans votre environnement ou votre fichier .env.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] Aucun composant renvoyé par l’API. Vérifiez que PROFOUND_API_KEY est valide et pointe vers le bon site Web.'
    );
  }

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

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

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

Votre CmsConfig devrait ressembler à

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

Dans notre package.json, nous définissons comment exécuter le script ainsi que quelques dépendances

REMARQUE : Si vous n’avez pas de tsconfig, vous pouvez supprimer l’option --tsconfig et sa valeur

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

À présent, après avoir exécuté

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

Nous devrions obtenir un résultat similaire et nous pouvons voir un nouveau fichier dans la structure de notre projet

apps/
 web/
 app/
   page.tsx
 scripts/
   generated-schema.ts // c’est là que réside notre script
 generated/
   cms-schema.ts // schéma Zod généré

Vous pouvez examiner l’intérieur pour voir à quoi ressemble votre schéma. Pour mettre à jour ce fichier, vous devez exécuter de nouveau la commande bun run generate-schemas, que vous pouvez connecter à votre flux de travail dev ou build.

Nous pouvons ensuite importer ces objets Zod dans notre fichier page.tsx de la manière suivante

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

// appelez petFoodPostSchema.parse(obj) pour une analyse à typage sûr des objets

Vous pouvez mettre à jour votre composant depuis le panneau d’administration et récupérer à nouveau le schéma mis à jour pour faciliter le développement

Previous‹Split Screen JSON Component Builder with LLM