Hurtigstart

Et indlæg om skemaer

Generér typesikre Zod-skemaer

Denne funktion gør det muligt at få dine komponenters beskrivelse i form af et typesikkert Zod-schema, som giver:

TypeScript-først skemavalidering
Statisk typeinferens

Læs mere: https://zod.dev

Opsætning

For at hente dit Zod-skema skal du:

Indlæs de nødvendige afhængigheder
Opret et script ved hjælp af hjælpefunktionerne fra cms-renderer

Projektstruktur

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

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 not set. Set it in your environment or .env file.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID is not set. Set it in your environment or .env file.'
    );
  }

  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY is not set. Set it in your environment or .env file.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] No components returned from the API. Check that PROFOUND_API_KEY is valid and points at the right website.'
    );
  }

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

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

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

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

Eksempel på CMS-konfiguration

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

Konfiguration af `package.json`

Bemærk: Hvis du ikke har en tsconfig.json, skal du fjerne flaget --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",
    "...": "..."
  }
}

Kørsel af scriptet

bun run generate-schemas

Eksempel på output:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] Found 3 components: post, categories, header
[generate-schemas] Done.

Opdateret projektstruktur

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

Anvendelse i `page.tsx`

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

// Brug til typesikker parsing
petFoodPostSchema.parse(obj);

Noter

Gennemgå den genererede fil for at forstå strukturen af din komponent
Kør scriptet igen, når strukturen af din komponent ændrer sig:

bun run generate-schemas

Du kan integrere dette i din udviklings- eller build-workflow
Opdater komponenter via administrationspanelet, og generér derefter lokalt igen

NextSplit Screen JSON Component Builder with LLM›

Hurtigstart

Et indlæg om skemaer

Generér typesikre Zod-skemaer

Denne funktion gør det muligt at få dine komponenters beskrivelse i form af et typesikkert Zod-schema, som giver:

TypeScript-først skemavalidering
Statisk typeinferens

Læs mere: https://zod.dev

Opsætning

For at hente dit Zod-skema skal du:

Indlæs de nødvendige afhængigheder
Opret et script ved hjælp af hjælpefunktionerne fra cms-renderer

Projektstruktur

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

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 not set. Set it in your environment or .env file.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID is not set. Set it in your environment or .env file.'
    );
  }

  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY is not set. Set it in your environment or .env file.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] No components returned from the API. Check that PROFOUND_API_KEY is valid and points at the right website.'
    );
  }

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

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

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

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

Eksempel på CMS-konfiguration

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

Konfiguration af `package.json`

Bemærk: Hvis du ikke har en tsconfig.json, skal du fjerne flaget --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",
    "...": "..."
  }
}

Kørsel af scriptet

bun run generate-schemas

Eksempel på output:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] Found 3 components: post, categories, header
[generate-schemas] Done.

Opdateret projektstruktur

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

Anvendelse i `page.tsx`

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

// Brug til typesikker parsing
petFoodPostSchema.parse(obj);

Noter

Gennemgå den genererede fil for at forstå strukturen af din komponent
Kør scriptet igen, når strukturen af din komponent ændrer sig:

bun run generate-schemas

Du kan integrere dette i din udviklings- eller build-workflow
Opdater komponenter via administrationspanelet, og generér derefter lokalt igen

NextSplit Screen JSON Component Builder with LLM›

Hurtigstart

Generér typesikre Zod-skemaer

Opsætning

Projektstruktur

Script: generated-schema.ts

Eksempel på CMS-konfiguration

Konfiguration af package.json

Kørsel af scriptet

Opdateret projektstruktur

Anvendelse i page.tsx

Noter

Hurtigstart

Generér typesikre Zod-skemaer

Opsætning

Projektstruktur

Script: generated-schema.ts

Eksempel på CMS-konfiguration

Konfiguration af package.json

Kørsel af scriptet

Opdateret projektstruktur

Anvendelse i page.tsx

Noter

Script: `generated-schema.ts`

Konfiguration af `package.json`

Anvendelse i `page.tsx`

Script: `generated-schema.ts`

Konfiguration af `package.json`

Anvendelse i `page.tsx`