json-to-compose: Instructions file for Codex

AGENTS.md - Guide for AI Agents

This document provides essential context for AI agents to collaborate effectively on this project.

Overview

json-to-compose is a Server-Driven UI (SDUI) framework for Kotlin Multiplatform that converts JSON structures into Jetpack Compose components at runtime.

Main use case: The backend controls the application's UI without requiring app updates.

Project Structure

json-to-compose/
├── library/       → Core library (published on Maven Central v1.0.3)
├── composy/       → Visual editor web/desktop
├── composeApp/    → Multiplatform demo app
├── server/        → Ktor Backend
└── shared/        → Shared utilities

Main Module: /library

Location of core code:

library/src/commonMain/kotlin/com/jesusdmedinac/jsontocompose/
├── JsonToCompose.kt              → Entry point, CompositionLocals, router
├── model/
│   ├── ComposeNode.kt            → Serializable UI tree node
│   ├── ComposeType.kt            → Component types enum
│   ├── ComposeModifier.kt        → Serializable modifiers
│   └── NodeProperties.kt         → Component-specific props (sealed interface)
├── renderer/
│   ├── ColumnRenderer.kt         → ComposeNode.ToColumn()
│   ├── RowRenderer.kt            → ComposeNode.ToRow()
│   ├── BoxRenderer.kt            → ComposeNode.ToBox()
│   ├── TextRenderer.kt           → ComposeNode.ToText()
│   ├── ButtonRenderer.kt         → ComposeNode.ToButton()
│   ├── ImageRenderer.kt          → ComposeNode.ToImage()
│   ├── TextFieldRenderer.kt      → ComposeNode.ToTextField()
│   ├── LazyColumnRenderer.kt     → ComposeNode.ToLazyColumn()
│   ├── LazyRowRenderer.kt        → ComposeNode.ToLazyRow()
│   ├── ScaffoldRenderer.kt       → ComposeNode.ToScaffold()
│   ├── CardRenderer.kt           → ComposeNode.ToCard()
│   ├── AlertDialogRenderer.kt    → ComposeNode.ToAlertDialog()
│   ├── TopAppBarRenderer.kt      → ComposeNode.ToTopAppBar()
│   ├── CustomRenderer.kt         → ComposeNode.ToCustom()
│   ├── Alignment.kt              → String → Compose Alignment mappers
│   └── Arrangment.kt             → String → Compose Arrangement mappers
├── modifier/
│   └── ModifierMapper.kt         → Applies modifier operations
├── behavior/
│   └── Behavior.kt               → Interface for click events
└── state/
    └── StateHost.kt              → Interface for state management