@reicek/neataptic-ts 0.1.24 → 0.1.26

package/test/examples/flappy_bird/browser-entry/host/README.md

@@ -50,56 +50,40 @@ Parameters:
 
 Returns: Canvas handles, stats cells and network render callback.
 
-### updateStatsTableValues
+### createHeaderFrameRenderer
 
 ```ts
-updateStatsTableValues(
-  statsValueByKey: Partial<Record<FlappyStatsKey, HTMLTableCellElement>>,
-  partialValues: Partial<Record<FlappyStatsKey, string>>,
-): void
+createHeaderFrameRenderer(
+  headerCanvas: HTMLCanvasElement,
+  headerContext: CanvasRenderingContext2D,
+): () => void
 ```
 
-Applies partial stat updates to the rendered stats table.
-
-The runtime writes HUD values incrementally, so the host exposes a narrow
-partial-update helper rather than requiring full table redraws.
+Creates the reusable title-frame renderer for the header canvas.
 
 Parameters:
-- `statsValueByKey` - - Lookup of stat keys to value cells.
-- `partialValues` - - Subset of values to write this tick.
+- `headerCanvas` - - Header canvas element.
+- `headerContext` - - Header canvas 2D context.
 
-Returns: Nothing.
+Returns: Callback that redraws the framed title.
 
-### resetHostContainer
+### createHostCanvasElements
 
 ```ts
-resetHostContainer(
-  containerElement: HTMLElement,
-): void
+createHostCanvasElements(
+  hostVisualPrimitives: HostVisualPrimitives,
+): HostCanvasElements
 ```
 
-Clears any previous runtime DOM before rebuilding the browser host tree.
+Creates the canvases and 2D contexts used by the host UI.
 
-The demo rebuilds the host from scratch on each startup so repeated runs begin
-from a known clean DOM state.
+The host manages three canvas surfaces with different jobs: a title/header
+frame, the main simulation view, and the side-panel network visualization.
 
 Parameters:
-- `containerElement` - - Root host container.
-
-Returns: Nothing.
-
-### resolveHostVisualPrimitives
-
-```ts
-resolveHostVisualPrimitives(): HostVisualPrimitives
-```
-
-Resolves shared border, shadow, and padding values for host assembly.
-
-Centralizing these primitives keeps the DOM-building code focused on layout
-structure instead of duplicating presentation constants everywhere.
+- `hostVisualPrimitives` - - Shared visual primitives for border and shadow styling.
 
-Returns: Shared visual primitives reused across host sections.
+Returns: Simulation, header, and network canvases with required contexts.
 
 ### createHostLayoutElements
 
@@ -119,41 +103,6 @@ Parameters:
 
 Returns: Layout elements grouped by host responsibility.
 
-### createHostCanvasElements
-
-```ts
-createHostCanvasElements(
-  hostVisualPrimitives: HostVisualPrimitives,
-): HostCanvasElements
-```
-
-Creates the canvases and 2D contexts used by the host UI.
-
-The host manages three canvas surfaces with different jobs: a title/header
-frame, the main simulation view, and the side-panel network visualization.
-
-Parameters:
-- `hostVisualPrimitives` - - Shared visual primitives for border and shadow styling.
-
-Returns: Simulation, header, and network canvases with required contexts.
-
-### createHeaderFrameRenderer
-
-```ts
-createHeaderFrameRenderer(
-  headerCanvas: HTMLCanvasElement,
-  headerContext: CanvasRenderingContext2D,
-): () => void
-```
-
-Creates the reusable title-frame renderer for the header canvas.
-
-Parameters:
-- `headerCanvas` - - Header canvas element.
-- `headerContext` - - Header canvas 2D context.
-
-Returns: Callback that redraws the framed title.
-
 ### createHostNetworkVisualizationController
 
 ```ts
@@ -173,49 +122,49 @@ Parameters:
 
 Returns: Renderer and redraw callbacks for the network panel.
 
-### mountCanvasHostTree
+### installCanvasHostResizeHooks
 
 ```ts
-mountCanvasHostTree(
-  containerElement: HTMLElement,
-  hostLayoutElements: HostLayoutElements,
-  headerCanvas: HTMLCanvasElement,
+installCanvasHostResizeHooks(
   canvas: HTMLCanvasElement,
+  hostLayoutElements: HostLayoutElements,
   networkCanvas: HTMLCanvasElement,
+  drawHeaderFrame: () => void,
+  hostNetworkVisualizationController: HostNetworkVisualizationController,
 ): void
 ```
 
-Mounts the completed host DOM tree into the container in final order.
+Installs responsive resize hooks for the simulation canvas and side panel.
 
 Parameters:
-- `containerElement` - - Root host container.
+- `canvas` - - Simulation canvas.
 - `hostLayoutElements` - - Prepared layout containers.
-- `headerCanvas` - - Header title canvas.
-- `canvas` - - Main simulation canvas.
 - `networkCanvas` - - Network visualization canvas.
+- `drawHeaderFrame` - - Callback that redraws the header title.
+- `hostNetworkVisualizationController` - - Network panel resize/redraw controller.
 
 Returns: Nothing.
 
-### installCanvasHostResizeHooks
+### mountCanvasHostTree
 
 ```ts
-installCanvasHostResizeHooks(
-  canvas: HTMLCanvasElement,
+mountCanvasHostTree(
+  containerElement: HTMLElement,
   hostLayoutElements: HostLayoutElements,
+  headerCanvas: HTMLCanvasElement,
+  canvas: HTMLCanvasElement,
   networkCanvas: HTMLCanvasElement,
-  drawHeaderFrame: () => void,
-  hostNetworkVisualizationController: HostNetworkVisualizationController,
 ): void
 ```
 
-Installs responsive resize hooks for the simulation canvas and side panel.
+Mounts the completed host DOM tree into the container in final order.
 
 Parameters:
-- `canvas` - - Simulation canvas.
+- `containerElement` - - Root host container.
 - `hostLayoutElements` - - Prepared layout containers.
+- `headerCanvas` - - Header title canvas.
+- `canvas` - - Main simulation canvas.
 - `networkCanvas` - - Network visualization canvas.
-- `drawHeaderFrame` - - Callback that redraws the header title.
-- `hostNetworkVisualizationController` - - Network panel resize/redraw controller.
 
 Returns: Nothing.
 
@@ -236,6 +185,57 @@ Parameters:
 
 Returns: Nothing.
 
+### resetHostContainer
+
+```ts
+resetHostContainer(
+  containerElement: HTMLElement,
+): void
+```
+
+Clears any previous runtime DOM before rebuilding the browser host tree.
+
+The demo rebuilds the host from scratch on each startup so repeated runs begin
+from a known clean DOM state.
+
+Parameters:
+- `containerElement` - - Root host container.
+
+Returns: Nothing.
+
+### resolveHostVisualPrimitives
+
+```ts
+resolveHostVisualPrimitives(): HostVisualPrimitives
+```
+
+Resolves shared border, shadow, and padding values for host assembly.
+
+Centralizing these primitives keeps the DOM-building code focused on layout
+structure instead of duplicating presentation constants everywhere.
+
+Returns: Shared visual primitives reused across host sections.
+
+### updateStatsTableValues
+
+```ts
+updateStatsTableValues(
+  statsValueByKey: Partial<Record<FlappyStatsKey, HTMLTableCellElement>>,
+  partialValues: Partial<Record<FlappyStatsKey, string>>,
+): void
+```
+
+Applies partial stat updates to the rendered stats table.
+
+The runtime writes HUD values incrementally, so the host exposes a narrow
+partial-update helper rather than requiring full table redraws.
+
+Parameters:
+- `statsValueByKey` - - Lookup of stat keys to value cells.
+- `partialValues` - - Subset of values to write this tick.
+
+Returns: Nothing.
+
 ## browser-entry/host/host.types.ts
 
 Public type contracts for the browser-entry host boundary.
@@ -270,20 +270,6 @@ Shared panel padding used by the host stats container.
 
 This controls the interior breathing room of the main stats panel.
 
-### FLAPPY_HOST_TABLE_HOST_PADDING
-
-Shared table host padding used by the stats value section.
-
-The table host gets slightly different padding so dense stat rows remain
-readable without wasting horizontal space.
-
-### FLAPPY_HOST_TABLE_FONT_SIZE
-
-Shared stats table font size.
-
-The table uses a compact monospace size so many HUD rows fit comfortably in
-the host panel.
-
 ### FLAPPY_HOST_PANEL_TRANSITION
 
 Shared panel max-height transition.
@@ -297,6 +283,20 @@ Shared stats split gap.
 
 This controls the gutter between the table column and the network panel.
 
+### FLAPPY_HOST_TABLE_FONT_SIZE
+
+Shared stats table font size.
+
+The table uses a compact monospace size so many HUD rows fit comfortably in
+the host panel.
+
+### FLAPPY_HOST_TABLE_HOST_PADDING
+
+Shared table host padding used by the stats value section.
+
+The table host gets slightly different padding so dense stat rows remain
+readable without wasting horizontal space.
+
 ## browser-entry/host/host.canvas.service.ts
 
 Canvas sizing helpers for the browser host boundary.