Component Zod Pull

Dohvatite Zod opis svojih komponenti u vrijeme kompilacije pomoću skripte

Ova značajka omogućuje vam da dobijete opis svoje komponente u obliku tip-sigurnog opisa „Zod”, koji pruža validaciju sheme usmjerenu na TypeScript i statičku inferenciju tipova za vaš sadržaj.

https://zod.dev

Kako bismo dohvatili našu Zod shemu, učitat ćemo neke ovisnosti i stvoriti skriptu koja koristi nekoliko pomoćnih funkcija iz našeg cms-renderer.

Krenimo s našom strukturom projekta

apps/
 web/
 app/
   page.tsx
 scripts/
   generate-schemas.ts // ovdje se nalazi naša skripta

Sada ćemo urediti ovu datoteku generated-schema.ts

import { fetchAllCustomSchemaFields, saveZodSchemaCode } from 'cms-renderer/lib/custom-schemas';
import { cmsConfig } from '../lib/cms-config'; // uvoz moje konfiguracije

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

  if (!cmsUrl) {
    throw new Error(
      '[generate-schemas] NEXT_PUBLIC_CMS_API_URL nije postavljen. Postavite ga u svojem okruženju ili .env datoteci.'
    );
  }
  if (!websiteId) {
    throw new Error(
      '[generate-schemas] NEXT_PUBLIC_PROFOUND_WEBSITE_ID nije postavljen. Postavite ga u svojem okruženju ili .env datoteci.'
    );
  }
  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY nije postavljen. Postavite ga u svojem okruženju ili .env datoteci.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] API nije vratio nijednu komponentu. Provjerite je li PROFOUND_API_KEY valjan i pokazuje li na ispravnu web-stranicu.'
    );
  }

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

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

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

Vaš CmsConfig trebao bi izgledati ovako

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

U našem package.json definiramo kako pokrenuti skriptu i neke ovisnosti

NAPOMENA: Ako nemate tsconfig, tada možete ukloniti zastavicu --tsconfig i njezinu vrijednost

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

Sada, nakon što pokrenemo

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

Trebali bismo dobiti sličan izlaz i u strukturi projekta vidjeti novu datoteku

apps/
 web/
 app/
   page.tsx
 scripts/
   generated-schema.ts // ovdje se nalazi naša skripta
 generated/
   cms-schema.ts // generirana zod shema

Možete je otvoriti i vidjeti kako vaša shema izgleda. Da biste ažurirali ovu datoteku, morate ponovno pokrenuti naredbu bun run generate-schemas, koju možete povezati sa svojim dev ili build radnim tokom.

Zatim možemo uvesti te zod objekte u našu datoteku page.tsx na sljedeći način

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

// pozovite petFoodPostSchema.parse(obj) za tip-sigurno parsiranje objekata

Svoju komponentu možete ažurirati iz administratorskog sučelja i ponovno dohvatiti ažuriranu shemu radi jednostavnijeg razvoja.

Previous‹Split Screen JSON Component Builder with LLM