mirror of
https://github.com/vercel-labs/json-render.git
synced 2026-09-14 13:41:32 +08:00
Chris Tate
714c38f2b8
* feat: add custom directives API and @json-render/directives package
Add a `defineDirective` API that lets users register custom `$`-prefixed
dynamic values with schemas, resolvers, and prompt instructions — extending
the spec language without forking core.
* fixes
* perf(core): optimize findDirective to iterate registry instead of object keys
Flip the loop from O(object-keys) to O(registry-size) by iterating
the directive registry and checking `key in value` rather than scanning
all object keys with Object.keys() and startsWith("$").
* fix(core): reject directive names that conflict with built-in keys
defineDirective now throws at registration time if the name collides
with a built-in prop expression key ($state, $cond, etc.), making the
precedence contract explicit rather than relying on check ordering in
resolvePropValue.
* fix(directives): handle future dates in $format and warn on $math NaN coercion
$format relative dates now support future timestamps ("2h from now")
and return "just now" for zero diff. $math emits a console.warn in
dev mode when a non-numeric value is silently coerced to 0.
* fix(directives): remove process.env check that breaks DTS build
The directives package doesn't include @types/node, so referencing
process.env fails during tsup's DTS generation. The console.warn is
unconditional now — it only fires on actual misuse (non-numeric input)
so the cost is negligible.
* feat(directives): rename prompt to description, auto-describe schemas in prompt, add docs
- Rename `prompt` to `description` on DirectiveDefinition — a short
behavioral label rather than the full AI prompt blob
- Auto-generate directive schema signatures in the system prompt using
formatZodType, so the AI always sees every field, type, and optionality
- Add docs: guide page, API reference page, nav/title entries, docs-chat
* feat(directives): add standardDirectives export and composition hint
Export a pre-assembled standardDirectives array (all 7 non-factory
directives) for convenience. Add a composition hint to the generated
AI prompt so agents know directives can nest inside each other.
* docs: add directives skill, README entry, and docs-chat listing
- Add skills/directives/SKILL.md with full directive API reference
- Add @json-render/directives row to root README packages table
- Add "directives" to the Available skills list in docs-chat prompt
* perf(core): skip Zod parse in directive hot path
Resolvers are already defensive (coercion, fallbacks, switch defaults),
so runtime validation on every render adds overhead without safety.
The schema remains used for prompt generation and TypeScript inference.
83 lines
3.1 KiB
TypeScript
83 lines
3.1 KiB
TypeScript
/**
|
|
* Single source of truth for page titles.
|
|
* Used by both page metadata exports and the OG image route.
|
|
*
|
|
* Keys mirror the page's URL path (e.g., "docs/changelog" → /og/docs/changelog).
|
|
* Values are display titles (without the "| json-render" suffix — the layout template adds that).
|
|
*/
|
|
export const PAGE_TITLES: Record<string, string> = {
|
|
// Home (no slug)
|
|
"": "The Generative UI\nFramework",
|
|
|
|
// Top-level
|
|
playground: "Playground",
|
|
examples: "Examples",
|
|
|
|
// Docs
|
|
docs: "Introduction",
|
|
"docs/quick-start": "Quick Start",
|
|
"docs/installation": "Installation",
|
|
"docs/catalog": "Catalog",
|
|
"docs/schemas": "Schemas",
|
|
"docs/specs": "Specs",
|
|
"docs/registry": "Registry",
|
|
"docs/streaming": "Streaming",
|
|
"docs/validation": "Validation",
|
|
"docs/data-binding": "Data Binding",
|
|
"docs/computed-values": "Computed Values",
|
|
"docs/visibility": "Visibility",
|
|
"docs/watchers": "Watchers",
|
|
"docs/renderers": "Renderers",
|
|
"docs/generation-modes": "Generation Modes",
|
|
"docs/code-export": "Code Export",
|
|
"docs/custom-schema": "Custom Schema & Renderer",
|
|
"docs/devtools": "Devtools",
|
|
"docs/ai-sdk": "AI SDK Integration",
|
|
"docs/adaptive-cards": "Adaptive Cards Integration",
|
|
"docs/openapi": "OpenAPI Integration",
|
|
"docs/a2ui": "A2UI Integration",
|
|
"docs/ag-ui": "AG-UI Integration",
|
|
"docs/migration": "Migration Guide",
|
|
"docs/changelog": "Changelog",
|
|
"docs/skills": "Skills",
|
|
"docs/directives": "Directives",
|
|
|
|
// API references
|
|
"docs/api/core": "@json-render/core API",
|
|
"docs/api/react": "@json-render/react API",
|
|
"docs/api/next": "@json-render/next API",
|
|
"docs/api/vue": "@json-render/vue API",
|
|
"docs/api/solid": "@json-render/solid API",
|
|
"docs/api/react-pdf": "@json-render/react-pdf API",
|
|
"docs/api/react-email": "@json-render/react-email API",
|
|
"docs/api/react-native": "@json-render/react-native API",
|
|
"docs/api/svelte": "@json-render/svelte API",
|
|
"docs/api/directives": "@json-render/directives API",
|
|
"docs/api/codegen": "@json-render/codegen API",
|
|
"docs/api/devtools": "@json-render/devtools API",
|
|
"docs/api/devtools-react": "@json-render/devtools-react API",
|
|
"docs/api/devtools-vue": "@json-render/devtools-vue API",
|
|
"docs/api/devtools-svelte": "@json-render/devtools-svelte API",
|
|
"docs/api/devtools-solid": "@json-render/devtools-solid API",
|
|
"docs/api/image": "@json-render/image API",
|
|
"docs/api/remotion": "@json-render/remotion API",
|
|
"docs/api/shadcn": "@json-render/shadcn API",
|
|
"docs/api/shadcn-svelte": "@json-render/shadcn-svelte API",
|
|
"docs/api/mcp": "@json-render/mcp API",
|
|
"docs/api/redux": "@json-render/redux API",
|
|
"docs/api/zustand": "@json-render/zustand API",
|
|
"docs/api/jotai": "@json-render/jotai API",
|
|
"docs/api/react-three-fiber": "@json-render/react-three-fiber API",
|
|
"docs/api/xstate": "@json-render/xstate API",
|
|
"docs/api/ink": "@json-render/ink API",
|
|
"docs/api/yaml": "@json-render/yaml API",
|
|
};
|
|
|
|
/**
|
|
* Get the page title for a given slug.
|
|
* Returns null if the slug is not in the whitelist.
|
|
*/
|
|
export function getPageTitle(slug: string): string | null {
|
|
return slug in PAGE_TITLES ? PAGE_TITLES[slug]! : null;
|
|
}
|