Quick start

Ett inlägg om scheman

Generera typsäkra Zod-scheman

Den här funktionen gör att du kan få beskrivningen av dina komponenter i form av ett typsäkert Zod-schema, vilket ger:

Schemavalidering med TypeScript som utgångspunkt
Statisk typinferens

Läs mer: https://zod.dev

Konfiguration

För att hämta ditt Zod-schema ska du:

Ladda in de nödvändiga beroendena
Skapa ett skript med hjälp av verktygen från cms-renderer

Projektstruktur

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

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 är inte angivet. Ange den i din miljö eller .env-fil.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID är inte angivet. Ange den i din miljö eller .env-fil.'
    );
  }

  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY är inte angivet. Ange den i din miljö eller .env-fil.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] Inga komponenter returnerades från API:et. Kontrollera att PROFOUND_API_KEY är giltig och pekar på rätt webbplats.'
    );
  }

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

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

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

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

Exempel på CMS-konfiguration

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

`package.json`-konfiguration

Observera: Om du inte har en tsconfig.json, ta bort flaggan --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öra skriptet

bun run generate-schemas

Exempelutdata:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] Hittade 3 komponenter: post, categories, header
[generate-schemas] Klart.

Uppdaterad projektstruktur

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

Användning i `page.tsx`

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

// Använd för typsäker tolkning
petFoodPostSchema.parse(obj);

Anteckningar

Inspektera den genererade filen för att förstå strukturen för din komponent
Kör skriptet igen när strukturen för din komponent förändras:

bun run generate-schemas

Du kan integrera detta i ditt utvecklings- eller byggarbetsflöde
Uppdatera komponenter via adminpanelen och generera sedan om lokalt

NextSplit Screen JSON Component Builder with LLM›

Quick start

Ett inlägg om scheman

Generera typsäkra Zod-scheman

Den här funktionen gör att du kan få beskrivningen av dina komponenter i form av ett typsäkert Zod-schema, vilket ger:

Schemavalidering med TypeScript som utgångspunkt
Statisk typinferens

Läs mer: https://zod.dev

Konfiguration

För att hämta ditt Zod-schema ska du:

Ladda in de nödvändiga beroendena
Skapa ett skript med hjälp av verktygen från cms-renderer

Projektstruktur

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

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 är inte angivet. Ange den i din miljö eller .env-fil.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID är inte angivet. Ange den i din miljö eller .env-fil.'
    );
  }

  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY är inte angivet. Ange den i din miljö eller .env-fil.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] Inga komponenter returnerades från API:et. Kontrollera att PROFOUND_API_KEY är giltig och pekar på rätt webbplats.'
    );
  }

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

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

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

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

Exempel på CMS-konfiguration

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

`package.json`-konfiguration

Observera: Om du inte har en tsconfig.json, ta bort flaggan --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öra skriptet

bun run generate-schemas

Exempelutdata:

tsx --tsconfig tsconfig.json scripts/generate-schemas.ts
[generate-schemas] Hittade 3 komponenter: post, categories, header
[generate-schemas] Klart.

Uppdaterad projektstruktur

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

Användning i `page.tsx`

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

// Använd för typsäker tolkning
petFoodPostSchema.parse(obj);

Anteckningar

Inspektera den genererade filen för att förstå strukturen för din komponent
Kör skriptet igen när strukturen för din komponent förändras:

bun run generate-schemas

Du kan integrera detta i ditt utvecklings- eller byggarbetsflöde
Uppdatera komponenter via adminpanelen och generera sedan om lokalt

NextSplit Screen JSON Component Builder with LLM›

Quick start

Generera typsäkra Zod-scheman

Konfiguration

Projektstruktur

Skript: generated-schema.ts

Exempel på CMS-konfiguration

package.json-konfiguration

Köra skriptet

Uppdaterad projektstruktur

Användning i page.tsx

Anteckningar

Quick start

Generera typsäkra Zod-scheman

Konfiguration

Projektstruktur

Skript: generated-schema.ts

Exempel på CMS-konfiguration

package.json-konfiguration

Köra skriptet

Uppdaterad projektstruktur

Användning i page.tsx

Anteckningar

Skript: `generated-schema.ts`

`package.json`-konfiguration

Användning i `page.tsx`

Skript: `generated-schema.ts`

`package.json`-konfiguration

Användning i `page.tsx`