Component Zod Pull

Stáhněte popis Zod svých komponent v čase kompilace pomocí skriptu

Tato funkce vám umožňuje získat popis vaší komponenty ve formě type-safe popisu "Zod", který poskytuje validaci schémat v režimu TS-first a statickou inferenci typů pro váš obsah.

https://zod.dev

Abychom získali naše schéma Zod, načteme několik závislostí a vytvoříme skript, který využívá některé utility z našeho cms-renderer

Začněme strukturou našeho projektu

apps/
 web/
 app/
   page.tsx
 scripts/
   generate-schemas.ts // zde žije náš skript

Nyní upravíme soubor generated-schema.ts

import { fetchAllCustomSchemaFields, saveZodSchemaCode } from 'cms-renderer/lib/custom-schemas';
import { cmsConfig } from '../lib/cms-config'; // importuji svou konfiguraci

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

  if (!cmsUrl) {
    throw new Error(
      '[generate-schemas] NEXT_PUBLIC_CMS_API_URL není nastavená. Nastavte ji ve svém prostředí nebo souboru .env.'
    );
  }
  if (!websiteId) {
    throw new Error(
      '[generate-schemas] NEXT_PUBLIC_PROFOUND_WEBSITE_ID není nastavené. Nastavte jej ve svém prostředí nebo souboru .env.'
    );
  }
  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY není nastavený. Nastavte jej ve svém prostředí nebo souboru .env.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] API nevrátilo žádné komponenty. Zkontrolujte, že PROFOUND_API_KEY je platný a odkazuje na správný web.'
    );
  }

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

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

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

Vaše CmsConfig by měla vypadat takto

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

Uvnitř našeho package.json definujeme, jak skript spustit, a několik závislostí

POZNÁMKA: Pokud nemáte tsconfig, můžete odebrat přepínač --tsconfig a jeho hodnotu

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

Nyní po spuštění

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

Měli bychom získat podobný výstup a uvidíme nový soubor ve struktuře projektu

apps/
 web/
 app/
   page.tsx
 scripts/
   generated-schema.ts // zde žije náš skript
 generated/
   cms-schema.ts // generované schéma zod

Můžete se podívat dovnitř a zjistit, jak schéma vypadá. Abyste tento soubor aktualizovali, musíte znovu spustit příkaz bun run generate-schemas, který můžete napojit na svůj pracovní postup dev nebo build.

Poté můžeme tyto objekty Zod načíst do našeho souboru page.tsx takto

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

// zavolejte petFoodPostSchema.parse(obj) pro type-safe parsování objektů

Komponentu můžete aktualizovat v administračním panelu a znovu stáhnout aktualizované schéma pro snadnější vývoj

Previous‹Json a claude kód