@shadow-garden/bapbong-layout-engine 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Le Phuoc Minh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,35 @@
+# @shadow-garden/bapbong-layout-engine
+
+The heart of the renderer: turns a ProseMirror document into a **paint-ready
+`ResolvedLayout`** — every glyph run, line, table cell, float and footnote with
+absolute page coordinates. The painter then just draws; it never measures.
+
+- **Scope:** `scope:engine`
+- **Depends on:** `@shadow-garden/bapbong-contracts`, `@shadow-garden/bapbong-model` (measurement is injected via `MeasureText`)
+
+## What it does
+
+- `toFlowBlocks(doc)` — schema document → flow model (`FlowParagraph` / `FlowTable` / …).
+- Line breaking, **pagination**, paragraph spacing/indent, tabs, hanging indents.
+- **Multi-column** sections (with column-height balancing), **floats** (text wrap),
+  page **headers/footers** (first/even variants), and **footnotes** reserved at the
+  page bottom (including refs inside table cells).
+- Threads `commentIds` / `footnoteRef` onto segments for the painter.
+
+## Public API
+
+```ts
+import { layout, createLayoutCache } from '@shadow-garden/bapbong-layout-engine';
+
+const cache = createLayoutCache();            // incremental table re-layout
+const resolved = layout(doc, config, measureText, { cache });
+```
+
+Also: `layoutBlocks`, `LayoutCache`, `PageChrome`.
+
+## Build / test
+
+```sh
+pnpm nx build @shadow-garden/bapbong-layout-engine
+pnpm nx test  @shadow-garden/bapbong-layout-engine
+```