Rychlý start

Příspěvek o schématech

Generování typově bezpečných schémat Zod

Tato funkce vám umožní získat popis komponent ve formě typově bezpečného schématu Zod, které poskytuje:

Validaci schématu orientovanou na TypeScript
Statickou inferenci typů

Více informací: https://zod.dev

Nastavení

Abyste získali své schéma Zod, musíte:

Načíst požadované závislosti
Vytvořit skript pomocí utilit z cms-renderer

Struktura projektu

apps/
  web/
    app/
      page.tsx
    scripts/
      generated-schema.ts   # soubor skriptu

Skript: `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] NEXT_PUBLIC_CMS_API_URL není nastaveno. Nastavte jej ve svém prostředí nebo souboru .env.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID není nastaveno. Nastavte jej ve svém prostředí nebo souboru .env.'
    );
  }

  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY není nastaveno. Nastavte jej ve svém prostředí nebo souboru .env.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] API nevrátilo žádné komponenty. Zkontrolujte, že PROFOUND_API_KEY je platný a ukazuje na správný web.'
    );
  }

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

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

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

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

Příklad konfigurace CMS

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

Konfigurace `package.json`

Poznámka: Pokud nemáte tsconfig.json, odstraňte příznak --tsconfig.

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

Spuštění skriptu

bun run generate-schemas

Ukázkový výstup:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] Nalezeny 3 komponenty: post, categories, header
[generate-schemas] Hotovo.

Aktualizovaná struktura projektu

apps/
  web/
    app/
      page.tsx
    scripts/
      generated-schema.ts
    generated/
      cms-schemas.ts   # vygenerované schéma Zod

Použití v `page.tsx`

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

// Použijte pro typově bezpečné parsování
petFoodPostSchema.parse(obj);

Poznámky

Zkontrolujte vygenerovaný soubor, abyste pochopili strukturu své komponenty
Pusťte skript znovu pokaždé, když se struktura vaší komponenty změní:

bun run generate-schemas

Můžete to integrovat do svého vývojového nebo build procesu
Aktualizujte komponenty přes administrační panel a poté je znovu vygenerujte lokálně

NextJson a claude kód›

Rychlý start

Příspěvek o schématech

Generování typově bezpečných schémat Zod

Tato funkce vám umožní získat popis komponent ve formě typově bezpečného schématu Zod, které poskytuje:

Validaci schématu orientovanou na TypeScript
Statickou inferenci typů

Více informací: https://zod.dev

Nastavení

Abyste získali své schéma Zod, musíte:

Načíst požadované závislosti
Vytvořit skript pomocí utilit z cms-renderer

Struktura projektu

apps/
  web/
    app/
      page.tsx
    scripts/
      generated-schema.ts   # soubor skriptu

Skript: `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] NEXT_PUBLIC_CMS_API_URL není nastaveno. Nastavte jej ve svém prostředí nebo souboru .env.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID není nastaveno. Nastavte jej ve svém prostředí nebo souboru .env.'
    );
  }

  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY není nastaveno. Nastavte jej ve svém prostředí nebo souboru .env.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] API nevrátilo žádné komponenty. Zkontrolujte, že PROFOUND_API_KEY je platný a ukazuje na správný web.'
    );
  }

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

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

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

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

Příklad konfigurace CMS

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

Konfigurace `package.json`

Poznámka: Pokud nemáte tsconfig.json, odstraňte příznak --tsconfig.

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

Spuštění skriptu

bun run generate-schemas

Ukázkový výstup:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] Nalezeny 3 komponenty: post, categories, header
[generate-schemas] Hotovo.

Aktualizovaná struktura projektu

apps/
  web/
    app/
      page.tsx
    scripts/
      generated-schema.ts
    generated/
      cms-schemas.ts   # vygenerované schéma Zod

Použití v `page.tsx`

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

// Použijte pro typově bezpečné parsování
petFoodPostSchema.parse(obj);

Poznámky

Zkontrolujte vygenerovaný soubor, abyste pochopili strukturu své komponenty
Pusťte skript znovu pokaždé, když se struktura vaší komponenty změní:

bun run generate-schemas

Můžete to integrovat do svého vývojového nebo build procesu
Aktualizujte komponenty přes administrační panel a poté je znovu vygenerujte lokálně

NextJson a claude kód›

Rychlý start

Generování typově bezpečných schémat Zod

Nastavení

Struktura projektu

Skript: generated-schema.ts

Příklad konfigurace CMS

Konfigurace package.json

Spuštění skriptu

Aktualizovaná struktura projektu

Použití v page.tsx

Poznámky

Rychlý start

Generování typově bezpečných schémat Zod

Nastavení

Struktura projektu

Skript: generated-schema.ts

Příklad konfigurace CMS

Konfigurace package.json

Spuštění skriptu

Aktualizovaná struktura projektu

Použití v page.tsx

Poznámky

Skript: `generated-schema.ts`

Konfigurace `package.json`

Použití v `page.tsx`

Skript: `generated-schema.ts`

Konfigurace `package.json`

Použití v `page.tsx`