Component Zod Pull

Obtenha a descrição Zod dos seus componentes em tempo de compilação usando um script

Este recurso permite que você obtenha a descrição do seu componente na forma de uma descrição "Zod" com tipagem segura, que oferece validação de esquema com foco em TS e inferência de tipos estática para o seu conteúdo.

https://zod.dev

Para obter nosso esquema Zod, vamos carregar algumas dependências e criar um script que usa algumas utilidades do nosso cms-renderer.

Vamos começar com a estrutura do nosso projeto

apps/
 web/
 app/
   page.tsx
 scripts/
   generate-schemas.ts // é aqui que o nosso script fica

Agora vamos editar o arquivo generated-schema.ts

import { fetchAllCustomSchemaFields, saveZodSchemaCode } from 'cms-renderer/lib/custom-schemas';
import { cmsConfig } from '../lib/cms-config'; // importando minha configuração

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

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

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] Nenhum componente retornado pela API. Verifique se PROFOUND_API_KEY é válido e aponta para o site correto.'
    );
  }

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

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

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

O seu CmsConfig deve ficar assim

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

Dentro do nosso package.json, definimos como executar o script e algumas dependências

OBSERVAÇÃO: Se você não tiver um tsconfig, pode remover a flag --tsconfig e o seu valor

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

Agora, depois de executar

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

Devemos obter uma saída semelhante e podemos ver um novo arquivo na estrutura do nosso projeto

apps/
 web/
 app/
   page.tsx
 scripts/
   generated-schema.ts // é aqui que o nosso script fica
 generated/
   cms-schema.ts // esquema Zod gerado

Você pode inspecionar o arquivo para ver como está o seu esquema. Para atualizar esse arquivo, é preciso executar novamente o comando bun run generate-schemas, que você pode conectar ao seu fluxo de trabalho de dev ou build.

Em seguida, podemos importar esses objetos Zod no nosso arquivo page.tsx da seguinte forma

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

// chame petFoodPostSchema.parse(obj) para fazer a análise de objetos com segurança de tipos

Você pode atualizar o seu componente no painel administrativo e puxar o esquema atualizado novamente para facilitar o desenvolvimento

Previous‹Split Screen JSON Component Builder with LLM