Início rápido

Gerar Schemas Zod com Tipagem Segura

Este recurso permite obter a descrição do seu schema na forma de um schema Zod com tipagem segura, fornecendo:

• Validação de schema priorizando TypeScript
• Inferência estática de tipos

Saiba mais: https://zod.dev

Configuração

Para obter seu schema Zod, você irá:

1. Carregar as dependências necessárias
2. Criar um script usando utilitários de cms-renderer

Estrutura do Projeto

apps/
  web/
    app/
      page.tsx
    scripts/
      generated-schema.ts   # arquivo de 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 não está definido. Defina-o no seu ambiente ou no arquivo .env.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID não está definido. Defina-o no seu ambiente ou no arquivo .env.'
    );
  }

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

  console.log('[generate-schemas] Concluído.');
}

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

Exemplo de Configuração do CMS

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

Configuração de package.json

Observação: Se você não tiver um tsconfig.json, remova a flag --tsconfig.

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

Executando o Script

bun run generate-schemas

Exemplo de saída:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] Concluído.

Estrutura do Projeto Atualizada

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

Uso em page.tsx

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

// Use para análise com tipagem segura
petFoodPostSchema.parse(obj);

Observações

• Inspecione o arquivo gerado para entender a estrutura do seu schema
• Execute o script novamente sempre que seu schema mudar:

bun run generate-schemas

• Você pode integrar isso ao seu fluxo de trabalho de desenvolvimento ou de build
• Atualize os schemas pelo painel administrativo e, em seguida, gere novamente localmente