profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Headless

Quick startJSON āđāļĨāļ° Claude Codeāļ”āļķāļ‡āļ„āļģāļ­āļ˜āļīāļšāļēāļĒ Zod āļ‚āļ­āļ‡āļ„āļ­āļĄāđ‚āļžāđ€āļ™āļ™āļ•āđŒ

REST API

REST API Overviewgetāđ€āļŠāļ·āđˆāļ­āļĄāļ•āđˆāļ­āđ€āļ§āđ‡āļšāđ„āļ‹āļ•āđŒāļāļąāļš CMS APIgetGET /routesgetGET /routegetGET /blocksgetāļĢāļąāļšāļšāļĨāđ‡āļ­āļāļžāļĢāđ‰āļ­āļĄāđāļ„āļŠ CELgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

Quick start

āđ‚āļžāļŠāļ•āđŒāđ€āļāļĩāđˆāļĒāļ§āļāļąāļšāļŠāļ„āļĩāļĄāļē

āļŠāļĢāđ‰āļēāļ‡āļŠāļ„āļĩāļĄāļē Zod āļ—āļĩāđˆāļ›āļĨāļ­āļ”āļ āļąāļĒāļ•āđˆāļ­āļ›āļĢāļ°āđ€āļ āļ—

āļ„āļļāļ“āļŠāļĄāļšāļąāļ•āļīāļ™āļĩāđ‰āļŠāđˆāļ§āļĒāđƒāļŦāđ‰āļ„āļļāļ“āđ„āļ”āđ‰āļĢāļąāļšāļ„āļģāļ­āļ˜āļīāļšāļēāļĒāļ‚āļ­āļ‡āļ„āļ­āļĄāđ‚āļžāđ€āļ™āļ™āļ•āđŒāđƒāļ™āļĢāļđāļ›āđāļšāļšāļ‚āļ­āļ‡āļŠāļ„āļĩāļĄāļēāļ—āļĩāđˆāļ›āļĨāļ­āļ”āļ āļąāļĒāļ•āđˆāļ­āļ›āļĢāļ°āđ€āļ āļ—āļ‚āļ­āļ‡ Zod āđ‚āļ”āļĒāļĄāļĩ:

  • āļāļēāļĢāļ•āļĢāļ§āļˆāļŠāļ­āļšāļŠāļ„āļĩāļĄāļēāļ—āļĩāđˆāđƒāļŦāđ‰āļ„āļ§āļēāļĄāļŠāļģāļ„āļąāļāļāļąāļš TypeScript āļāđˆāļ­āļ™
  • āļāļēāļĢāļ­āļ™āļļāļĄāļēāļ™āļ›āļĢāļ°āđ€āļ āļ—āđāļšāļšāļ„āļ‡āļ—āļĩāđˆ

āđ€āļĢāļĩāļĒāļ™āļĢāļđāđ‰āđ€āļžāļīāđˆāļĄāđ€āļ•āļīāļĄ: https://zod.dev

āļāļēāļĢāļ•āļąāđ‰āļ‡āļ„āđˆāļē

āđ€āļžāļ·āđˆāļ­āļ”āļķāļ‡āļŠāļ„āļĩāļĄāļē Zod āļ‚āļ­āļ‡āļ„āļļāļ“ āļ„āļļāļ“āļˆāļ°āļ•āđ‰āļ­āļ‡:

  1. āđ‚āļŦāļĨāļ” dependencies āļ—āļĩāđˆāļˆāļģāđ€āļ›āđ‡āļ™
  2. āļŠāļĢāđ‰āļēāļ‡āļŠāļ„āļĢāļīāļ›āļ•āđŒāđ‚āļ”āļĒāđƒāļŠāđ‰āļĒāļđāļ—āļīāļĨāļīāļ•āļĩāđ‰āļˆāļēāļ cms-renderer

āđ‚āļ„āļĢāļ‡āļŠāļĢāđ‰āļēāļ‡āđ‚āļ›āļĢāđ€āļˆāļāļ•āđŒ

apps/
  web/
    app/
      page.tsx
    scripts/
      generated-schema.ts   # āđ„āļŸāļĨāđŒāļŠāļ„āļĢāļīāļ›āļ•āđŒ

āļŠāļ„āļĢāļīāļ›āļ•āđŒ: 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);
});

āļ•āļąāļ§āļ­āļĒāđˆāļēāļ‡āļāļēāļĢāļ•āļąāđ‰āļ‡āļ„āđˆāļē CMS Config

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

āļāļēāļĢāļ•āļąāđ‰āļ‡āļ„āđˆāļē package.json

āļŦāļĄāļēāļĒāđ€āļŦāļ•āļļ: āļŦāļēāļāļ„āļļāļ“āđ„āļĄāđˆāļĄāļĩ tsconfig.json āđƒāļŦāđ‰āļĨāļšāđāļŸāļĨāđ‡āļ --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",
    "...": "..."
  }
}

āļāļēāļĢāļĢāļąāļ™āļŠāļ„āļĢāļīāļ›āļ•āđŒ

bun run generate-schemas

āļ•āļąāļ§āļ­āļĒāđˆāļēāļ‡āļœāļĨāļĨāļąāļžāļ˜āđŒ:

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

āđ‚āļ„āļĢāļ‡āļŠāļĢāđ‰āļēāļ‡āđ‚āļ›āļĢāđ€āļˆāļāļ•āđŒāļ—āļĩāđˆāļ­āļąāļ›āđ€āļ”āļ•

apps/
  web/
    app/
      page.tsx
    scripts/
      generated-schema.ts
    generated/
      cms-schemas.ts   # āļŠāļ„āļĩāļĄāļē Zod āļ—āļĩāđˆāļŠāļĢāđ‰āļēāļ‡āļ‚āļķāđ‰āļ™

āļāļēāļĢāđƒāļŠāđ‰āļ‡āļēāļ™āđƒāļ™ page.tsx

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

// āđƒāļŠāđ‰āļŠāļģāļŦāļĢāļąāļšāļāļēāļĢāđāļ›āļĨāļ‡āļ„āđˆāļēāļ­āļĒāđˆāļēāļ‡āļ›āļĨāļ­āļ”āļ āļąāļĒāļ•āđˆāļ­āļ›āļĢāļ°āđ€āļ āļ—
petFoodPostSchema.parse(obj);

āļšāļąāļ™āļ—āļķāļāđ€āļžāļīāđˆāļĄāđ€āļ•āļīāļĄ

  • āļ•āļĢāļ§āļˆāļŠāļ­āļšāđ„āļŸāļĨāđŒāļ—āļĩāđˆāļŠāļĢāđ‰āļēāļ‡āļ‚āļķāđ‰āļ™āđ€āļžāļ·āđˆāļ­āļ—āļģāļ„āļ§āļēāļĄāđ€āļ‚āđ‰āļēāđƒāļˆāđ‚āļ„āļĢāļ‡āļŠāļĢāđ‰āļēāļ‡āļ‚āļ­āļ‡āļ„āļ­āļĄāđ‚āļžāđ€āļ™āļ™āļ•āđŒāļ‚āļ­āļ‡āļ„āļļāļ“
  • āļĢāļąāļ™āļŠāļ„āļĢāļīāļ›āļ•āđŒāļ­āļĩāļāļ„āļĢāļąāđ‰āļ‡āļ—āļļāļāļ„āļĢāļąāđ‰āļ‡āļ—āļĩāđˆāđ‚āļ„āļĢāļ‡āļŠāļĢāđ‰āļēāļ‡āļ„āļ­āļĄāđ‚āļžāđ€āļ™āļ™āļ•āđŒāļ‚āļ­āļ‡āļ„āļļāļ“āđ€āļ›āļĨāļĩāđˆāļĒāļ™āđāļ›āļĨāļ‡:
bun run generate-schemas
  • āļ„āļļāļ“āļŠāļēāļĄāļēāļĢāļ–āļœāļŠāļēāļ™āļŠāļīāđˆāļ‡āļ™āļĩāđ‰āđ€āļ‚āđ‰āļēāļāļąāļšāđ€āļ§āļīāļĢāđŒāļāđ‚āļŸāļĨāļ§āđŒāļāļēāļĢāļžāļąāļ’āļ™āļēāļŦāļĢāļ·āļ­āļāļēāļĢ build āļ‚āļ­āļ‡āļ„āļļāļ“āđ„āļ”āđ‰
  • āļ­āļąāļ›āđ€āļ”āļ•āļ„āļ­āļĄāđ‚āļžāđ€āļ™āļ™āļ•āđŒāļœāđˆāļēāļ™āđāļœāļ‡āļœāļđāđ‰āļ”āļđāđāļĨāļĢāļ°āļšāļš āļˆāļēāļāļ™āļąāđ‰āļ™āļŠāļĢāđ‰āļēāļ‡āđƒāļŦāļĄāđˆāļ āļēāļĒāđƒāļ™āđ€āļ„āļĢāļ·āđˆāļ­āļ‡
Continue Reading
NextJSON āđāļĨāļ° Claude Code‹