Szybki start

Generowanie bezpiecznych typowo schematów Zod

Ta funkcja umożliwia uzyskanie opisu schematu w postaci bezpiecznego typowo schematu Zod, zapewniając:

• Walidację schematów zorientowaną na TypeScript
• Statyczne wnioskowanie typów

Dowiedz się więcej: https://zod.dev

Konfiguracja

Aby pobrać swój schemat Zod, należy:

1. Załadować wymagane zależności
2. Utworzyć skrypt z wykorzystaniem narzędzi z cms-renderer

Struktura projektu

apps/
  web/
    app/
      page.tsx
    scripts/
      generated-schema.ts   # plik skryptu

Skrypt: 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 is not set. Set it in your environment or .env file.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID is not set. Set it in your environment or .env file.'
    );
  }

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

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

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

Przykład konfiguracji CMS

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

Konfiguracja package.json

Uwaga: Jeśli nie masz pliku tsconfig.json, usuń flagę --tsconfig.

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

Uruchamianie skryptu

bun run generate-schemas

Przykładowy wynik:

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

Zaktualizowana struktura projektu

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

Użycie w page.tsx

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

// Użyj do typowo bezpiecznego parsowania
petFoodPostSchema.parse(obj);

Uwagi

• Przeanalizuj wygenerowany plik, aby zrozumieć strukturę schematu
• Uruchom ponownie skrypt za każdym razem, gdy schemat ulegnie zmianie:

bun run generate-schemas

• Możesz zintegrować to ze swoim procesem deweloperskim lub budowania
• Aktualizuj schematy przez panel administracyjny, a następnie generuj je ponownie lokalnie