@reicek/neataptic-ts 0.1.24 → 0.1.26

package/test/examples/flappy_bird/browser-entry/playback/worker-channel/README.md

@@ -15,6 +15,13 @@ plus `0.4` carried forward to the next render tick.
 
 ## browser-entry/playback/worker-channel/playback.worker-channel.types.ts
 
+### PlaybackStepPayload
+
+Shared alias for the worker playback-step payload.
+
+This keeps the playback worker-channel modules focused on playback semantics
+instead of long imported protocol names.
+
 ### PlaybackStepRequest
 
 Request payload for one playback-step worker call.
@@ -36,13 +43,6 @@ Output for the resolved playback-step request and frame-budget remainder.
 The resolved request records both the integer step batch to send now and the
 leftover fractional budget to carry into the next render tick.
 
-### PlaybackStepPayload
-
-Shared alias for the worker playback-step payload.
-
-This keeps the playback worker-channel modules focused on playback semantics
-instead of long imported protocol names.
-
 ## browser-entry/playback/worker-channel/playback.worker-channel.request.services.ts
 
 Playback batch-request helpers for the browser worker channel.
@@ -78,6 +78,29 @@ Once the worker replies with a playback-step payload, these helpers turn that
 raw protocol data into the browser-facing telemetry and end-of-episode summary
 values used elsewhere in the playback loop.
 
+### resolvePlaybackCompletionSummary
+
+```ts
+resolvePlaybackCompletionSummary(
+  playbackStepPayload: { requestId: number; snapshot: EvolutionPlaybackStepSnapshot; instrumentation?: { activationCallsPerFrame: number; simulationStepsPerRaf: number; } | undefined; done: boolean; averagePipesPassed?: number | undefined; p90FramesSurvived?: number | undefined; winnerPipesPassed?: number | undefined; winnerFramesSurvived?: number | undefined; },
+  latestLeaderPipesPassed: number,
+  latestLeaderFramesSurvived: number,
+): { averagePipesPassed: number; p90FramesSurvived: number; winnerPipesPassed: number; winnerFramesSurvived: number; }
+```
+
+Resolves final playback summary values when the worker reports completion.
+
+Some end-of-episode aggregates may be omitted from the worker payload, so the
+browser falls back to the latest leader values it has already observed during
+playback.
+
+Parameters:
+- `playbackStepPayload` - - Playback payload returned by worker.
+- `latestLeaderPipesPassed` - - Last observed leader pipes passed fallback.
+- `latestLeaderFramesSurvived` - - Last observed leader frames fallback.
+
+Returns: Final aggregate playback summary.
+
 ### resolvePlaybackFrameStats
 
 ```ts
@@ -103,26 +126,3 @@ Parameters:
 - `leaderFramesSurvived` - - Current frame leader survived frames.
 
 Returns: Normalized per-frame HUD telemetry payload.
-
-### resolvePlaybackCompletionSummary
-
-```ts
-resolvePlaybackCompletionSummary(
-  playbackStepPayload: { requestId: number; snapshot: EvolutionPlaybackStepSnapshot; instrumentation?: { activationCallsPerFrame: number; simulationStepsPerRaf: number; } | undefined; done: boolean; averagePipesPassed?: number | undefined; p90FramesSurvived?: number | undefined; winnerPipesPassed?: number | undefined; winnerFramesSurvived?: number | undefined; },
-  latestLeaderPipesPassed: number,
-  latestLeaderFramesSurvived: number,
-): { averagePipesPassed: number; p90FramesSurvived: number; winnerPipesPassed: number; winnerFramesSurvived: number; }
-```
-
-Resolves final playback summary values when the worker reports completion.
-
-Some end-of-episode aggregates may be omitted from the worker payload, so the
-browser falls back to the latest leader values it has already observed during
-playback.
-
-Parameters:
-- `playbackStepPayload` - - Playback payload returned by worker.
-- `latestLeaderPipesPassed` - - Last observed leader pipes passed fallback.
-- `latestLeaderFramesSurvived` - - Last observed leader frames fallback.
-
-Returns: Final aggregate playback summary.

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

@@ -14,6 +14,13 @@ control presented as one small API.
 
 ## browser-entry/runtime/runtime.ts
 
+### RuntimeRunHandle
+
+Public run handle returned by the browser runtime entrypoint.
+
+The handle is intentionally minimal so callers can treat the demo like a
+long-running process with start/stop/status semantics.
+
 ### start
 
 ```ts
@@ -44,13 +51,6 @@ runHandle.stop();
 await runHandle.done;
 ```
 
-### RuntimeRunHandle
-
-Public run handle returned by the browser runtime entrypoint.
-
-The handle is intentionally minimal so callers can treat the demo like a
-long-running process with start/stop/status semantics.
-
 ## browser-entry/runtime/runtime.types.ts
 
 Core runtime contracts for the Flappy Bird browser demo.
@@ -59,20 +59,6 @@ The runtime boundary is where the browser-side application comes together:
 DOM host setup, worker creation, telemetry wiring, lifecycle control, and the
 configuration passed into the evolution loop.
 
-### RuntimeRunHandle
-
-Public run handle returned by the browser runtime entrypoint.
-
-The handle is intentionally minimal so callers can treat the demo like a
-long-running process with start/stop/status semantics.
-
-### RuntimeGlobalWindow
-
-Browser `window` extension shape used for global runtime wiring.
-
-This keeps the auto-start and compatibility globals typed without coupling
-the runtime modules directly to ad hoc window-property access.
-
 ### RuntimeContainerTarget
 
 Container argument accepted by the browser runtime start function.
@@ -80,12 +66,12 @@ Container argument accepted by the browser runtime start function.
 Callers can either pass a host element directly or provide an element id for
 late resolution inside the runtime startup path.
 
-### RuntimeStartConfig
+### RuntimeGlobalWindow
 
-Static runtime configuration resolved before the browser loop starts.
+Browser `window` extension shape used for global runtime wiring.
 
-These values define the high-level NEAT and network shape used for the whole
-browser session.
+This keeps the auto-start and compatibility globals typed without coupling
+the runtime modules directly to ad hoc window-property access.
 
 ### RuntimeHostViewContext
 
@@ -101,6 +87,20 @@ Mutable lifecycle state used to coordinate stop semantics and completion.
 The runtime loop is asynchronous and long-lived, so the browser keeps a small
 shared lifecycle object for idempotent shutdown and completion signaling.
 
+### RuntimeRunHandle
+
+Public run handle returned by the browser runtime entrypoint.
+
+The handle is intentionally minimal so callers can treat the demo like a
+long-running process with start/stop/status semantics.
+
+### RuntimeStartConfig
+
+Static runtime configuration resolved before the browser loop starts.
+
+These values define the high-level NEAT and network shape used for the whole
+browser session.
+
 ### RuntimeStartContext
 
 Shared runtime startup dependencies created before evolution begins.
@@ -116,6 +116,19 @@ These functions cover the pre-loop phase: resolve the host container, build a
 typed browser view, derive static config, create telemetry state, spawn the
 worker, and paint the initial HUD before evolution begins.
 
+### createRuntimeStartConfig
+
+```ts
+createRuntimeStartConfig(): RuntimeStartConfig
+```
+
+Resolves the static runtime configuration used during browser startup.
+
+Centralizing the configuration fold here makes the runtime entry read as
+orchestration instead of constant plumbing.
+
+Returns: Runtime configuration derived from shared constants.
+
 ### createRuntimeStartContext
 
 ```ts
@@ -153,19 +166,6 @@ Parameters:
 
 Returns: Nothing.
 
-### createRuntimeStartConfig
-
-```ts
-createRuntimeStartConfig(): RuntimeStartConfig
-```
-
-Resolves the static runtime configuration used during browser startup.
-
-Centralizing the configuration fold here makes the runtime entry read as
-orchestration instead of constant plumbing.
-
-Returns: Runtime configuration derived from shared constants.
-
 ## browser-entry/runtime/runtime.lifecycle.service.ts
 
 Lifecycle and teardown helpers for the browser runtime.
@@ -247,6 +247,27 @@ for the next evolved generation, updates the HUD and network view, plays back
 that generation on the canvas, then folds the outcome into best-so-far
 browser state.
 
+### resolveGenerationPopulationNetworks
+
+```ts
+resolveGenerationPopulationNetworks(
+  generationPayload: { populationNetworksJson?: Record<string, unknown>[] | undefined; },
+  bestNetwork: default | undefined,
+): default[]
+```
+
+Resolves the browser-side network cache for the current playback generation.
+
+Playback birds are created from the generation population in stable array
+order, so the browser can reuse this ordered cache to redraw the network
+panel when the red-bird champion changes.
+
+Parameters:
+- `generationPayload` - - Worker generation-ready payload.
+- `bestNetwork` - - Current generation best-network fallback.
+
+Returns: Ordered population networks for the upcoming playback session.
+
 ### runRuntimeEvolutionLoop
 
 ```ts
@@ -276,27 +297,6 @@ Dependencies required to run the browser runtime evolution loop.
 Grouping these dependencies into one object keeps the public loop entry more
 declarative and avoids a long positional parameter list.
 
-### resolveGenerationPopulationNetworks
-
-```ts
-resolveGenerationPopulationNetworks(
-  generationPayload: { populationNetworksJson?: Record<string, unknown>[] | undefined; },
-  bestNetwork: default | undefined,
-): default[]
-```
-
-Resolves the browser-side network cache for the current playback generation.
-
-Playback birds are created from the generation population in stable array
-order, so the browser can reuse this ordered cache to redraw the network
-panel when the red-bird champion changes.
-
-Parameters:
-- `generationPayload` - - Worker generation-ready payload.
-- `bestNetwork` - - Current generation best-network fallback.
-
-Returns: Ordered population networks for the upcoming playback session.
-
 ## browser-entry/runtime/runtime.telemetry.service.ts
 
 Runtime telemetry helpers for live browser HUD updates.