profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

ניתוב פרמטריסוגי רכיביםSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyכתיבת סקריפטים בבונה התבניותProject Scaffoldingספריית המדיה

ללא ראש

התחלה מהירהSplit Screen JSON Component Builder with LLMComponent Zod Pull

ממשק REST

סקירת REST APIgetחיבור-אתר-ל-API-של-CMSgetGET /routesgetGET /routegetקבלת בלוקיםgetהשגת-בלוקים-עם-מטמון-CELgetGET /blocks/generatedgetקבל רכיביםgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postתרגום פוסטpatchPATCH /translationsgetGET /usagepostפוסט-CSVpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

התחלה מהירה

פוסט על סכימות

יצירת סכמות Zod בטוחות לסוג

תכונה זו מאפשרת לך לקבל את תיאור הרכיבים שלך בצורת סכמת Zod בטוחה לסוג, המספקת:

  • אימות סכמות עם עדיפות ל-TypeScript
  • הסקת סוגים סטטית

למידע נוסף: https://zod.dev

הגדרה

כדי למשוך את סכמת ה-Zod שלך, עליך:

  1. לטעון את התלויות הנדרשות
  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 לא הוגדר. הגדר אותו במשתני הסביבה שלך או בקובץ .env.'
    );
  }

  if (!websiteId) {
    throw new Error(
      '[generate-schemas] CMS_WEBSITE_ID לא הוגדר. הגדר אותו במשתני הסביבה שלך או בקובץ .env.'
    );
  }

  if (!apiKey) {
    throw new Error(
      '[generate-schemas] PROFOUND_API_KEY לא הוגדר. הגדר אותו במשתני הסביבה שלך או בקובץ .env.'
    );
  }

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

  if (schemas.length === 0) {
    throw new Error(
      '[generate-schemas] אף רכיב לא הוחזר מה-API. ודא ש-PROFOUND_API_KEY תקין ומצביע על האתר הנכון.'
    );
  }

  console.log(
    `[generate-schemas] נמצאו ${schemas.length} רכיבים: ${schemas.map((s) => s.name).join(', ')}`
  );

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

  console.log('[generate-schemas] הושלם.');
}

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

דוגמת הגדרת CMS

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] נמצאו 3 רכיבים: post, categories, header
[generate-schemas] הושלם.

מבנה הפרויקט המעודכן

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
  • באפשרותך לשלב זאת בזרימת העבודה של הפיתוח או הבנייה שלך
  • עדכן רכיבים דרך לוח הניהול ולאחר מכן הפק מחדש באופן מקומי
Continue Reading
NextSplit Screen JSON Component Builder with LLM›