Inicio rápido

Generar esquemas Zod con tipos seguros

Esta función te permite obtener la descripción de tu esquema en forma de un esquema Zod con tipos seguros, proporcionando:

• Validación de esquemas con enfoque en TypeScript
• Inferencia de tipos estática

Más información: https://zod.dev

Configuración

Para obtener tu esquema Zod, debes:

1. Cargar las dependencias necesarias
2. Crear un script utilizando utilidades de cms-renderer

Estructura del proyecto

apps/
  web/
    app/
      page.tsx
    scripts/
      generated-schema.ts   # archivo del script

Script: 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 no está definida. Configúrala en tu entorno o archivo .env.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID no está definida. Configúrala en tu entorno o archivo .env.'
    );
  }

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

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

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

Ejemplo de configuración de CMS

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

Configuración de package.json

Nota: Si no tienes un tsconfig.json, elimina la bandera --tsconfig.

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

Ejecución del script

bun run generate-schemas

Ejemplo de salida:

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

Estructura del proyecto actualizada

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

Uso en page.tsx

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

// Usar para un análisis con tipos seguros
petFoodPostSchema.parse(obj);

Notas

• Inspecciona el archivo generado para comprender la estructura de tu esquema
• Vuelve a ejecutar el script cada vez que cambie tu esquema:

bun run generate-schemas

• Puedes integrarlo en tu flujo de trabajo de desarrollo o de compilación
• Actualiza los esquemas desde el panel de administración y luego regenera localmente