# izhanruaif/flam-adaptive-layout-engine-assignment architecture

> Architecture diagram of the GitHub repository izhanruaif/flam-adaptive-layout-engine-assignment, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/izhanruaif/flam-adaptive-layout-engine-assignment
- Repository: https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment

## Overview

Flam is a declarative ad-layout engine demonstrated through an interactive React app. Users choose a predefined surface or enter custom dimensions; the app resolves the ad specification into positioned elements and displays that result through either the DOM or Canvas renderer. The core stages are specification, surface profiles, constraint-based resolution, and rendering. README documents scaling, aspect-ratio strategies, and priority degradation as resolver capabilities. The sampled files show the main wiring; other UI details and unexcerpted resolver logic are not asserted beyond documented behavior.

Main entry points: [`src/App.tsx`](https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/App.tsx) (Demo controls), [`src/resolver.ts`](https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/resolver.ts) (Layout resolver), [`src/spec.ts`](https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/spec.ts) (Ad specification), [`src/render-dom.tsx`](https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/render-dom.tsx) (DOM renderer)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_demo["Interactive Demo"]
  node_app["Demo controls<br/>[App.tsx]"]
  node_entry["React entry<br/>[main.tsx]"]
end

subgraph group_model["Layout Inputs"]
  node_spec["Ad specification<br/>[spec.ts]"]
  node_surfaces["Surface profiles<br/>[surfaces.ts]"]
end

subgraph group_engine["Resolution Engine"]
  node_resolver["Layout resolver<br/>[resolver.ts]"]
end

subgraph group_render["Renderers"]
  node_dom["DOM renderer<br/>[render-dom.tsx]"]
  node_canvas["Canvas renderer<br/>[render-canvas.ts]"]
end

node_user(("Demo user"))
node_browser(("Browser display"))

node_user -->|"chooses surface"| node_app
node_entry -->|"renders"| node_app
node_app -->|"defines ad"| node_spec
node_app -->|"selects profiles"| node_surfaces
node_app -->|"resolves layout"| node_resolver
node_resolver -->|"reads elements"| node_spec
node_resolver -->|"reads constraints"| node_surfaces
node_app -->|"renders DOM"| node_dom
node_app -->|"renders canvas"| node_canvas
node_dom -->|"reads content"| node_spec
node_dom -->|"uses coordinates"| node_resolver
node_canvas -->|"reads content"| node_spec
node_canvas -->|"uses coordinates"| node_resolver
node_app -.->|"displays result"| node_browser

click node_app "https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/App.tsx"
click node_entry "https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/main.tsx"
click node_spec "https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/spec.ts"
click node_surfaces "https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/surfaces.ts"
click node_resolver "https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/resolver.ts"
click node_dom "https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/render-dom.tsx"
click node_canvas "https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/render-canvas.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_entry,node_user,node_browser toneBlue
class node_spec,node_surfaces toneAmber
class node_resolver toneMint
class node_dom,node_canvas toneRose
```

## Components

### Interactive Demo

- [Demo controls](https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/App.tsx): `src/App.tsx`
- [React entry](https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/main.tsx): `src/main.tsx`

### Layout Inputs

- [Ad specification](https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/spec.ts): `src/spec.ts`
- [Surface profiles](https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/surfaces.ts): `src/surfaces.ts`

### Resolution Engine

- [Layout resolver](https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/resolver.ts): `src/resolver.ts`

### Renderers

- [DOM renderer](https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/render-dom.tsx): `src/render-dom.tsx`
- [Canvas renderer](https://github.com/izhanruaif/flam-adaptive-layout-engine-assignment/blob/main/src/render-canvas.ts): `src/render-canvas.ts`

### Other components

- **Demo user**
- **Browser display**

## Connections

- Demo user → Demo controls: chooses surface (evidence: `src/App.tsx`)
- React entry → Demo controls: renders (evidence: `src/main.tsx`)
- Demo controls → Ad specification: defines ad (evidence: `src/App.tsx`)
- Demo controls → Surface profiles: selects profiles (evidence: `src/App.tsx`)
- Demo controls → Layout resolver: resolves layout (evidence: `src/App.tsx`)
- Layout resolver → Ad specification: reads elements (evidence: `src/resolver.ts`)
- Layout resolver → Surface profiles: reads constraints (evidence: `src/resolver.ts`)
- Demo controls → DOM renderer: renders DOM (evidence: `src/App.tsx`)
- Demo controls → Canvas renderer: renders canvas (evidence: `src/App.tsx`)
- DOM renderer → Ad specification: reads content (evidence: `src/render-dom.tsx`)
- DOM renderer → Layout resolver: uses coordinates (evidence: `src/render-dom.tsx`)
- Canvas renderer → Ad specification: reads content (evidence: `src/render-canvas.ts`)
- Canvas renderer → Layout resolver: uses coordinates (evidence: `src/render-canvas.ts`)
- Demo controls → Browser display: displays result
