Snelstart

Een bericht over schema's

Typeveilige Zod-schema's genereren

Met deze functie kun je de beschrijving van je componenten verkrijgen in de vorm van een typeveilig Zod-schema, dat het volgende biedt:

Schema-validatie met TypeScript als uitgangspunt
Statische type-inferentie

Meer informatie: https://zod.dev

Installatie

Om je Zod-schema op te halen, moet je:

De vereiste afhankelijkheden laden
Een script maken met hulpprogramma's uit cms-renderer

Projectstructuur

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

Script: `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 is niet ingesteld. Stel deze in je omgeving of .env-bestand in.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID is niet ingesteld. Stel deze in je omgeving of .env-bestand in.'
    );
  }

  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY is niet ingesteld. Stel deze in je omgeving of .env-bestand in.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] Geen componenten teruggestuurd door de API. Controleer of PROFOUND_API_KEY geldig is en naar de juiste website verwijst.'
    );
  }

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

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

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

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

CMS-configuratievoorbeeld

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

`package.json`-configuratie

Opmerking: Als je geen tsconfig.json hebt, verwijder dan de --tsconfig-vlag.

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

Het script uitvoeren

bun run generate-schemas

Voorbeelduitvoer:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] 3 componenten gevonden: post, categories, header
[generate-schemas] Klaar.

Bijgewerkte projectstructuur

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

Gebruik in `page.tsx`

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

// Gebruik voor typeveilige parsing
petFoodPostSchema.parse(obj);

Opmerkingen

Bekijk het gegenereerde bestand om de structuur van je component te begrijpen
Voer het script opnieuw uit wanneer de structuur van je component verandert:

bun run generate-schemas

Je kunt dit integreren in je ontwikkelings- of buildworkflow
Werk componenten bij via het beheerderspaneel en genereer ze vervolgens lokaal opnieuw

NextSplit Screen JSON Component Builder with LLM›

Snelstart

Een bericht over schema's

Typeveilige Zod-schema's genereren

Met deze functie kun je de beschrijving van je componenten verkrijgen in de vorm van een typeveilig Zod-schema, dat het volgende biedt:

Schema-validatie met TypeScript als uitgangspunt
Statische type-inferentie

Meer informatie: https://zod.dev

Installatie

Om je Zod-schema op te halen, moet je:

De vereiste afhankelijkheden laden
Een script maken met hulpprogramma's uit cms-renderer

Projectstructuur

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

Script: `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 is niet ingesteld. Stel deze in je omgeving of .env-bestand in.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID is niet ingesteld. Stel deze in je omgeving of .env-bestand in.'
    );
  }

  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY is niet ingesteld. Stel deze in je omgeving of .env-bestand in.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] Geen componenten teruggestuurd door de API. Controleer of PROFOUND_API_KEY geldig is en naar de juiste website verwijst.'
    );
  }

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

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

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

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

CMS-configuratievoorbeeld

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

`package.json`-configuratie

Opmerking: Als je geen tsconfig.json hebt, verwijder dan de --tsconfig-vlag.

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

Het script uitvoeren

bun run generate-schemas

Voorbeelduitvoer:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] 3 componenten gevonden: post, categories, header
[generate-schemas] Klaar.

Bijgewerkte projectstructuur

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

Gebruik in `page.tsx`

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

// Gebruik voor typeveilige parsing
petFoodPostSchema.parse(obj);

Opmerkingen

Bekijk het gegenereerde bestand om de structuur van je component te begrijpen
Voer het script opnieuw uit wanneer de structuur van je component verandert:

bun run generate-schemas

Je kunt dit integreren in je ontwikkelings- of buildworkflow
Werk componenten bij via het beheerderspaneel en genereer ze vervolgens lokaal opnieuw

NextSplit Screen JSON Component Builder with LLM›

Snelstart

Typeveilige Zod-schema's genereren

Installatie

Projectstructuur

Script: generated-schema.ts

CMS-configuratievoorbeeld

package.json-configuratie

Het script uitvoeren

Bijgewerkte projectstructuur

Gebruik in page.tsx

Opmerkingen

Snelstart

Typeveilige Zod-schema's genereren

Installatie

Projectstructuur

Script: generated-schema.ts

CMS-configuratievoorbeeld

package.json-configuratie

Het script uitvoeren

Bijgewerkte projectstructuur

Gebruik in page.tsx

Opmerkingen

Script: `generated-schema.ts`

`package.json`-configuratie

Gebruik in `page.tsx`

Script: `generated-schema.ts`

`package.json`-configuratie

Gebruik in `page.tsx`