Component Zod Pull

Pobierz opis Zod swoich komponentów w czasie kompilacji za pomocą skryptu

Ta funkcja pozwala uzyskać opis komponentu w postaci bezpiecznego typowo opisu "Zod", który zapewnia walidację schematu zorientowaną na TS oraz statyczne wnioskowanie typów dla twoich treści.

https://zod.dev

Aby pobrać nasz schemat Zod, załadujemy kilka zależności i utworzymy skrypt, który wykorzystuje niektóre narzędzia z naszego cms-renderer.

Zacznijmy od struktury naszego projektu

apps/
 web/
 app/
   page.tsx
 scripts/
   generate-schemas.ts // tutaj znajduje się nasz skrypt

Teraz edytujemy plik generated-schema.ts

import { fetchAllCustomSchemaFields, saveZodSchemaCode } from 'cms-renderer/lib/custom-schemas';
import { cmsConfig } from '../lib/cms-config'; // importuję moją konfigurację

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

  if (!cmsUrl) {
    throw new Error(
      '[generate-schemas] NEXT_PUBLIC_CMS_API_URL nie jest ustawiona. Ustaw ją w swoim środowisku lub pliku .env.'
    );
  }
  if (!websiteId) {
    throw new Error(
      '[generate-schemas] NEXT_PUBLIC_PROFOUND_WEBSITE_ID nie jest ustawiony. Ustaw go w swoim środowisku lub pliku .env.'
    );
  }
  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY nie jest ustawiony. Ustaw go w swoim środowisku lub pliku .env.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] API nie zwróciło żadnych komponentów. Sprawdź, czy PROFOUND_API_KEY jest poprawny i wskazuje właściwą witrynę.'
    );
  }

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

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

main().catch((err) => {
 console.error('[generate-schemas] Nie powiodło się:', err);
  process.exit(1);
});

Twój obiekt CmsConfig powinien wyglądać następująco

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

W pliku package.json definiujemy, jak uruchomić skrypt oraz niektóre zależności

UWAGA: Jeśli nie masz pliku tsconfig, możesz usunąć flagę --tsconfig wraz z jej wartością

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

Teraz, po uruchomieniu

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

Powinniśmy otrzymać podobne wyjście i zobaczymy nowy plik w strukturze projektu

apps/
 web/
 app/
   page.tsx
 scripts/
   generated-schema.ts // tutaj znajduje się nasz skrypt
 generated/
   cms-schema.ts // wygenerowany schemat zod

Możesz zajrzeć do środka i zobaczyć, jak wygląda twój schemat. Aby zaktualizować ten plik, musisz ponownie uruchomić polecenie bun run generate-schemas, które możesz połączyć ze swoim przepływem pracy dev lub build.

Następnie możemy pobrać te obiekty zod do naszego pliku page.tsx w następujący sposób

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

// wywołaj petFoodPostSchema.parse(obj), aby uzyskać bezpieczne typowanie podczas parsowania obiektów

Możesz zaktualizować swój komponent z panelu administracyjnego i ponownie pobrać zaktualizowany schemat, aby ułatwić rozwój.

Previous‹Split Screen JSON Component Builder with LLM