Component Zod Pull

Tõmba oma komponentide Zodi kirjeldus kompileerimise ajal skripti abil

See funktsioon võimaldab saada oma komponendi kirjelduse tüüpturvalise „Zodi” kirjelduse kujul, mis pakub TS-eeskätt skeemi valideerimist ja staatilist tüübijäreldust sinu sisule.

https://zod.dev

Et tõmmata meie Zodi skeem, laadime mõned sõltuvused ja loome skripti, mis kasutab mõningaid tööriistu meie cms-rendererist.

Alustame oma projektistruktuurist

apps/
 web/
 app/
   page.tsx
 scripts/
   generate-schemas.ts // siin asub meie skript

Nüüd muudame seda faili generated-schema.ts

import { fetchAllCustomSchemaFields, saveZodSchemaCode } from 'cms-renderer/lib/custom-schemas';
import { cmsConfig } from '../lib/cms-config'; // impordin oma konfiguratsiooni

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

  if (!cmsUrl) {
    throw new Error(
      '[generate-schemas] NEXT_PUBLIC_CMS_API_URL ei ole määratud. Määra see oma keskkonnas või .env-failis.'
    );
  }
  if (!websiteId) {
    throw new Error(
      '[generate-schemas] NEXT_PUBLIC_PROFOUND_WEBSITE_ID ei ole määratud. Määra see oma keskkonnas või .env-failis.'
    );
  }
  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY ei ole määratud. Määra see oma keskkonnas või .env-failis.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] API ei tagastanud ühtegi komponenti. Kontrolli, et PROFOUND_API_KEY oleks kehtiv ja osutaks õigele veebisaidile.'
    );
  }

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

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

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

Sinu CmsConfig peaks välja nägema järgmine

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

Failis package.json määratleme, kuidas skripti käivitada, ning mõned sõltuvused

MÄRKUS: Kui sul ei ole tsconfig'it, võid --tsconfig lipu ja selle väärtuse eemaldada

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

Nüüd, kui käivitame

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

Peaksime saama sarnase väljundi ning näeme oma projektistruktuuris uut faili

apps/
 web/
 app/
   page.tsx
 scripts/
   generated-schema.ts // siin asub meie skript
 generated/
   cms-schema.ts // genereeritud Zodi skeem

Saad seda faili uurida ja näha, milline sinu skeem välja näeb. Selle faili uuendamiseks pead käsu bun run generate-schemas uuesti käivitama; selle saad ühendada oma dev- või build-töövooga.

Seejärel saame need Zodi objektid faili page.tsx järgmise näite abil tuua

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

// kutsu petFoodPostSchema.parse(obj), et objekte tüüpturvaliselt parsida

Saad oma komponenti adminpaneelis uuendada ning tõmmata uuendatud skeemi uuesti, et arendus oleks lihtsam

Previous‹Split Screen JSON Component Builder with LLM