Quick start

Egy bejegyzés a sémákról

Típusbiztos Zod sémák generálása

Ez a funkció lehetővé teszi, hogy a komponenseid leírását típusbiztos Zod sémaként kapd meg, és a következőket nyújtja:

TypeScript-központú sémaellenőrzés
Statikus típuslevezetés

További információ: https://zod.dev

Beállítás

A Zod sémád lekéréséhez a következőket tedd:

Töltsd be a szükséges függőségeket
Hozz létre egy szkriptet a cms-renderer segédeszközeivel

Projektstruktúra

apps/
  web/
    app/
      page.tsx
    scripts/
      generated-schema.ts   # szkriptfájl

Szkript: `generated-schema.ts`

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

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

  if (!cmsUrl) {
    throw new Error(
      '[generate-schemas] A NEXT_PUBLIC_CMS_API_URL nincs beállítva. Állítsd be a környezetben vagy az .env fájlban.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] A CMS_WEBSITE_ID nincs beállítva. Állítsd be a környezetben vagy az .env fájlban.'
    );
  }

  if (!apiKey) {
    throw new Error(
      '[generate-schemas] A PROFOUND_API_KEY nincs beállítva. Állítsd be a környezetben vagy az .env fájlban.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] Az API nem adott vissza komponenseket. Ellenőrizd, hogy a PROFOUND_API_KEY érvényes-e, és a megfelelő webhelyre mutat-e.'
    );
  }

  console.log(
    `[generate-schemas] ${schemas.length} komponenst találtunk: ${schemas.map((s) => s.name).join(', ')}`
  );

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

  console.log('[generate-schemas] Kész.');
}

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

CMS konfigurációs példa

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

`package.json` konfiguráció

Megjegyzés: Ha nincs tsconfig.json fájlod, távolítsd el a --tsconfig kapcsolót.

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

A szkript futtatása

bun run generate-schemas

Példa kimenet:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] 3 komponenst találtunk: post, categories, header
[generate-schemas] Kész.

Frissített projektstruktúra

apps/
  web/
    app/
      page.tsx
    scripts/
      generated-schema.ts
    generated/
      cms-schemas.ts   # generált Zod séma

Használat a `page.tsx` fájlban

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

// Használd típusbiztos feldolgozáshoz
petFoodPostSchema.parse(obj);

Megjegyzések

Vizsgáld meg a generált fájlt, hogy megértsd a komponensed felépítését
Futtasd újra a szkriptet, valahányszor megváltozik a komponensed struktúrája:

bun run generate-schemas

Integrálhatod ezt a fejlesztési vagy build munkafolyamatodba
Frissítsd a komponenseket az adminfelületen, majd generáld újra helyben

NextJSON és Claude kód›

Quick start

Egy bejegyzés a sémákról

Típusbiztos Zod sémák generálása

Ez a funkció lehetővé teszi, hogy a komponenseid leírását típusbiztos Zod sémaként kapd meg, és a következőket nyújtja:

TypeScript-központú sémaellenőrzés
Statikus típuslevezetés

További információ: https://zod.dev

Beállítás

A Zod sémád lekéréséhez a következőket tedd:

Töltsd be a szükséges függőségeket
Hozz létre egy szkriptet a cms-renderer segédeszközeivel

Projektstruktúra

apps/
  web/
    app/
      page.tsx
    scripts/
      generated-schema.ts   # szkriptfájl

Szkript: `generated-schema.ts`

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

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

  if (!cmsUrl) {
    throw new Error(
      '[generate-schemas] A NEXT_PUBLIC_CMS_API_URL nincs beállítva. Állítsd be a környezetben vagy az .env fájlban.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] A CMS_WEBSITE_ID nincs beállítva. Állítsd be a környezetben vagy az .env fájlban.'
    );
  }

  if (!apiKey) {
    throw new Error(
      '[generate-schemas] A PROFOUND_API_KEY nincs beállítva. Állítsd be a környezetben vagy az .env fájlban.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] Az API nem adott vissza komponenseket. Ellenőrizd, hogy a PROFOUND_API_KEY érvényes-e, és a megfelelő webhelyre mutat-e.'
    );
  }

  console.log(
    `[generate-schemas] ${schemas.length} komponenst találtunk: ${schemas.map((s) => s.name).join(', ')}`
  );

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

  console.log('[generate-schemas] Kész.');
}

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

CMS konfigurációs példa

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

`package.json` konfiguráció

Megjegyzés: Ha nincs tsconfig.json fájlod, távolítsd el a --tsconfig kapcsolót.

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

A szkript futtatása

bun run generate-schemas

Példa kimenet:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] 3 komponenst találtunk: post, categories, header
[generate-schemas] Kész.

Frissített projektstruktúra

apps/
  web/
    app/
      page.tsx
    scripts/
      generated-schema.ts
    generated/
      cms-schemas.ts   # generált Zod séma

Használat a `page.tsx` fájlban

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

// Használd típusbiztos feldolgozáshoz
petFoodPostSchema.parse(obj);

Megjegyzések

Vizsgáld meg a generált fájlt, hogy megértsd a komponensed felépítését
Futtasd újra a szkriptet, valahányszor megváltozik a komponensed struktúrája:

bun run generate-schemas

Integrálhatod ezt a fejlesztési vagy build munkafolyamatodba
Frissítsd a komponenseket az adminfelületen, majd generáld újra helyben

NextJSON és Claude kód›

Quick start

Típusbiztos Zod sémák generálása

Beállítás

Projektstruktúra

Szkript: generated-schema.ts

CMS konfigurációs példa

package.json konfiguráció

A szkript futtatása

Frissített projektstruktúra

Használat a page.tsx fájlban

Megjegyzések

Quick start

Típusbiztos Zod sémák generálása

Beállítás

Projektstruktúra

Szkript: generated-schema.ts

CMS konfigurációs példa

package.json konfiguráció

A szkript futtatása

Frissített projektstruktúra

Használat a page.tsx fájlban

Megjegyzések

Szkript: `generated-schema.ts`

`package.json` konfiguráció

Használat a `page.tsx` fájlban

Szkript: `generated-schema.ts`

`package.json` konfiguráció

Használat a `page.tsx` fájlban