Architecture Overview

System Overview

Layer Boundaries

This repository works best when four boundaries stay explicit:

• generator-sdk owns platform capabilities
• generator-workbench owns the official shell
• the generator runtime owns business state and rendering
• the host page decides how the runtime is mounted

If a generator must support both full-page editing and embedded template scenarios, the runtime should converge to Runtime Contract instead of relying on ad-hoc host bridges.

Release Handoff

The platform-side release path is:

1. local engineering finishes integration
2. build artifacts are uploaded through the developer console
3. the platform review flow runs
4. approved generators are hosted and exposed through platform entry points

This repository mostly covers stages 1 and 2.

SDK Internal Structure

At a high level, the SDK is organized into:

• core/ for config, HTTP, storage, and event infrastructure
• modules/ for auth, cloud, history, credits, billing, and export
• helpers/ for utilities such as withBilling
• types/ for public type definitions

Tech Stack

• TypeScript
• Vite library mode
• ESM + UMD + declaration outputs
• framework-agnostic API design

Read Next

• Guide Overview
• Generator Workbench
• Runtime Contract