@reicek/neataptic-ts 0.1.25 → 0.1.26

package/test/examples/asciiMaze/browser-entry/README.md

@@ -29,9 +29,21 @@ await handle.done;
 unsubscribe();
 ```
 
-### BrowserEntryStartOptions
+### BrowserEntryCurriculumContext
 
-Options accepted by the browser-hosted ASCII Maze entrypoint.
+State and callbacks used by the curriculum runtime service.
+
+### BrowserEntryEvolutionSettings
+
+Evolution settings used for a single procedural maze phase.
+
+### BrowserEntryHostElements
+
+Resolved host elements used by logger, dashboard, and resize services.
+
+### BrowserEntryHostServices
+
+Browser host services assembled for one running demo instance.
 
 ### BrowserEntryStartFunction
 
@@ -44,6 +56,14 @@ BrowserEntryStartFunction(
 
 Stable callable shape used by globals compatibility wiring.
 
+### BrowserEntryStartOptions
+
+Options accepted by the browser-hosted ASCII Maze entrypoint.
+
+### BrowserEntryTelemetryHub
+
+Lightweight telemetry hub contract shared between host and public handle.
+
 ### RuntimeAbortSignal
 
 Runtime AbortSignal shape used for older or polyfilled environments.
@@ -56,27 +76,38 @@ AbortSignal constructor shape with optional static composition helpers.
 
 Global namespace exposed for direct browser-script loading compatibility.
 
-### BrowserEntryHostElements
+## browser-entry/browser-entry.ts
 
-Resolved host elements used by logger, dashboard, and resize services.
+### AsciiMazeRunHandle
 
-### BrowserEntryEvolutionSettings
+Public lifecycle handle returned by the browser demo entrypoint.
 
-Evolution settings used for a single procedural maze phase.
+Example:
 
-### BrowserEntryTelemetryHub
+```ts
+const handle = await start('ascii-maze-output');
+const unsubscribe = handle.onTelemetry((telemetry) => {
+  console.log('generation', telemetry.generation);
+});
 
-Lightweight telemetry hub contract shared between host and public handle.
+await handle.done;
+unsubscribe();
+```
 
-### BrowserEntryHostServices
+### BrowserEntryStartFunction
 
-Browser host services assembled for one running demo instance.
+```ts
+BrowserEntryStartFunction(
+  container: string | HTMLElement | undefined,
+  opts: BrowserEntryStartOptions | undefined,
+): Promise<AsciiMazeRunHandle>
+```
 
-### BrowserEntryCurriculumContext
+Stable callable shape used by globals compatibility wiring.
 
-State and callbacks used by the curriculum runtime service.
+### BrowserEntryStartOptions
 
-## browser-entry/browser-entry.ts
+Options accepted by the browser-hosted ASCII Maze entrypoint.
 
 ### start
 
@@ -113,37 +144,6 @@ setTimeout(() => abortController.abort(), 1_000);
 await handle.done;
 ```
 
-### AsciiMazeRunHandle
-
-Public lifecycle handle returned by the browser demo entrypoint.
-
-Example:
-
-```ts
-const handle = await start('ascii-maze-output');
-const unsubscribe = handle.onTelemetry((telemetry) => {
-  console.log('generation', telemetry.generation);
-});
-
-await handle.done;
-unsubscribe();
-```
-
-### BrowserEntryStartFunction
-
-```ts
-BrowserEntryStartFunction(
-  container: string | HTMLElement | undefined,
-  opts: BrowserEntryStartOptions | undefined,
-): Promise<AsciiMazeRunHandle>
-```
-
-Stable callable shape used by globals compatibility wiring.
-
-### BrowserEntryStartOptions
-
-Options accepted by the browser-hosted ASCII Maze entrypoint.
-
 ## browser-entry/browser-entry.services.ts
 
 Compatibility facade for the dedicated browser-entry service modules.
@@ -168,30 +168,30 @@ Parameters:
 
 Returns: A signal that aborts when either source aborts.
 
-### runBrowserEntryCurriculum
+### createBrowserEntryEvolutionHostAdapter
 
 ```ts
-runBrowserEntryCurriculum(
-  context: BrowserEntryCurriculumContext,
-): void
+createBrowserEntryEvolutionHostAdapter(): EvolutionHostAdapter
 ```
 
-Run the progressive browser curriculum across increasingly larger mazes.
-
-Parameters:
-- `context` - - Runtime dashboard, cancellation, and completion callbacks for one browser session.
+Create the browser-owned engine host adapter used for pause polling and solve notifications.
 
-Returns: Nothing.
+Returns: Host adapter that keeps browser globals and DOM events out of engine internals.
 
-### createBrowserEntryEvolutionHostAdapter
+### createBrowserEntryHostServices
 
 ```ts
-createBrowserEntryEvolutionHostAdapter(): EvolutionHostAdapter
+createBrowserEntryHostServices(
+  hostElements: BrowserEntryHostElements,
+): BrowserEntryHostServices
 ```
 
-Create the browser-owned engine host adapter used for pause polling and solve notifications.
+Create the browser host services used by one ASCII Maze demo run.
 
-Returns: Host adapter that keeps browser globals and DOM events out of engine internals.
+Parameters:
+- `hostElements` - - Resolved host elements for live output, archive output, and resize observation.
+
+Returns: Dashboard, telemetry hub, runtime dashboard adapter, and resize cleanup.
 
 ### installBrowserEntryGlobals
 
@@ -208,20 +208,20 @@ Parameters:
 
 Returns: Nothing.
 
-### createBrowserEntryHostServices
+### runBrowserEntryCurriculum
 
 ```ts
-createBrowserEntryHostServices(
-  hostElements: BrowserEntryHostElements,
-): BrowserEntryHostServices
+runBrowserEntryCurriculum(
+  context: BrowserEntryCurriculumContext,
+): void
 ```
 
-Create the browser host services used by one ASCII Maze demo run.
+Run the progressive browser curriculum across increasingly larger mazes.
 
 Parameters:
-- `hostElements` - - Resolved host elements for live output, archive output, and resize observation.
+- `context` - - Runtime dashboard, cancellation, and completion callbacks for one browser session.
 
-Returns: Dashboard, telemetry hub, runtime dashboard adapter, and resize cleanup.
+Returns: Nothing.
 
 ## browser-entry/browser-entry.constants.ts
 
@@ -381,21 +381,6 @@ Returns: Nothing.
 
 ## browser-entry/browser-entry.utils.ts
 
-### resolveBrowserEntryHostElements
-
-```ts
-resolveBrowserEntryHostElements(
-  container: string | HTMLElement,
-): BrowserEntryHostElements
-```
-
-Resolve the browser host elements used by the demo logger and dashboard.
-
-Parameters:
-- `container` - - Element id or host element provided by the caller.
-
-Returns: Resolved host, archive, live, and resize-observer targets.
-
 ### createBrowserEvolutionSettings
 
 ```ts
@@ -411,19 +396,6 @@ Parameters:
 
 Returns: Per-phase evolution settings consumed by the curriculum runtime.
 
-### scheduleBrowserEntryFrame
-
-```ts
-scheduleBrowserEntryFrame(
-  callback: () => void,
-): void
-```
-
-Schedule follow-up curriculum work on the next animation tick when possible.
-
-Parameters:
-- `callback` - - Follow-up phase callback.
-
 ### didSolveBrowserMaze
 
 ```ts
@@ -453,3 +425,31 @@ Parameters:
 - `currentDimension` - - Current maze side length.
 
 Returns: Next side length to use.
+
+### resolveBrowserEntryHostElements
+
+```ts
+resolveBrowserEntryHostElements(
+  container: string | HTMLElement,
+): BrowserEntryHostElements
+```
+
+Resolve the browser host elements used by the demo logger and dashboard.
+
+Parameters:
+- `container` - - Element id or host element provided by the caller.
+
+Returns: Resolved host, archive, live, and resize-observer targets.
+
+### scheduleBrowserEntryFrame
+
+```ts
+scheduleBrowserEntryFrame(
+  callback: () => void,
+): void
+```
+
+Schedule follow-up curriculum work on the next animation tick when possible.
+
+Parameters:
+- `callback` - - Follow-up phase callback.

package/test/examples/asciiMaze/dashboardManager/README.md

@@ -8,32 +8,8 @@ class-based API stable while delegating the heavy work to focused helpers.
 
 ## dashboardManager/dashboardManager.types.ts
 
-### NeatGenome
-
-NEAT genome/network with runtime properties used by dashboard telemetry.
-
-### NeatSpecies
-
-NEAT species collection entry surface used by dashboard telemetry.
-
-### NeatInstance
-
-NEAT instance shape needed by dashboard helpers.
-
-### OperatorStatsEntry
-
-Operator stats entry from NEAT.
-
-### NumericTelemetryMap
-
 ### AsciiMazeComplexityStats
 
-### MutationStatsMap
-
-### DashboardTelemetry
-
-Raw telemetry shape received from NEAT dashboard integrations.
-
 ### AsciiMazeDetailedStats
 
 Expanded telemetry details retained by the dashboard between redraws.
@@ -42,29 +18,17 @@ Expanded telemetry details retained by the dashboard between redraws.
 
 Public telemetry snapshot surfaced to browser consumers.
 
-### DashboardTelemetryPayload
-
-Telemetry payload emitted through events, postMessage, and runtime hooks.
-
-### SolvedMazeRecord
-
-Stored solved-maze archive entry.
-
 ### CurrentBestRecord
 
 Latest best candidate used by live rendering and telemetry.
 
-### DashboardHistoryState
-
-Bounded numeric histories used for trends and exports.
-
-### DashboardScratchState
-
-Reused scratch arrays to keep redraw allocations predictable.
-
-### DashboardManagerState
+### DashboardArchiveFunction
 
-Mutable runtime state owned by one dashboard instance.
+```ts
+DashboardArchiveFunction(
+  args: unknown[],
+): void
+```
 
 ### DashboardClearFunction
 
@@ -72,6 +36,10 @@ Mutable runtime state owned by one dashboard instance.
 DashboardClearFunction(): void
 ```
 
+### DashboardHistoryState
+
+Bounded numeric histories used for trends and exports.
+
 ### DashboardLogFunction
 
 ```ts
@@ -80,13 +48,29 @@ DashboardLogFunction(
 ): void
 ```
 
-### DashboardArchiveFunction
+### DashboardManagerContext
 
-```ts
-DashboardArchiveFunction(
-  args: unknown[],
-): void
-```
+Shared runtime context passed into dashboard services.
+
+### DashboardManagerState
+
+Mutable runtime state owned by one dashboard instance.
+
+### DashboardManagerUpdateArgs
+
+Input accepted by the update orchestration service.
+
+### DashboardPresentationAdapter
+
+Shared presentation adapter used by browser and non-browser hosts.
+
+### DashboardScratchState
+
+Reused scratch arrays to keep redraw allocations predictable.
+
+### DashboardTelemetry
+
+Raw telemetry shape received from NEAT dashboard integrations.
 
 ### DashboardTelemetryHook
 
@@ -96,22 +80,38 @@ DashboardTelemetryHook(
 ): void
 ```
 
-### DashboardManagerContext
+### DashboardTelemetryPayload
 
-Shared runtime context passed into dashboard services.
+Telemetry payload emitted through events, postMessage, and runtime hooks.
 
-### DashboardManagerUpdateArgs
+### MutationStatsMap
 
-Input accepted by the update orchestration service.
+### NeatGenome
 
-### DashboardPresentationAdapter
+NEAT genome/network with runtime properties used by dashboard telemetry.
 
-Shared presentation adapter used by browser and non-browser hosts.
+### NeatInstance
+
+NEAT instance shape needed by dashboard helpers.
+
+### NeatSpecies
+
+NEAT species collection entry surface used by dashboard telemetry.
+
+### NumericTelemetryMap
+
+### OperatorStatsEntry
+
+Operator stats entry from NEAT.
 
 ### RuntimeDashboardManager
 
 Compatibility alias for older runtime-facing imports.
 
+### SolvedMazeRecord
+
+Stored solved-maze archive entry.
+
 ## dashboardManager/dashboardManager.ts
 
 ### DashboardManager
@@ -178,23 +178,6 @@ Parameters:
 
 ## dashboardManager/dashboardManager.services.ts
 
-### redrawDashboard
-
-```ts
-redrawDashboard(
-  context: DashboardManagerContext,
-  currentMaze: string[],
-  neat: unknown,
-): void
-```
-
-Repaint the live dashboard from current state and refresh the detailed snapshot.
-
-Parameters:
-- `context` - - Dashboard runtime context for state and output callbacks.
-- `currentMaze` - - Maze currently being evolved.
-- `neat` - - Optional NEAT runtime instance used for detailed stats.
-
 ### applyDashboardUpdate
 
 ```ts
@@ -225,6 +208,23 @@ Parameters:
 
 Returns: Public telemetry snapshot used by browser hosts.
 
+### redrawDashboard
+
+```ts
+redrawDashboard(
+  context: DashboardManagerContext,
+  currentMaze: string[],
+  neat: unknown,
+): void
+```
+
+Repaint the live dashboard from current state and refresh the detailed snapshot.
+
+Parameters:
+- `context` - - Dashboard runtime context for state and output callbacks.
+- `currentMaze` - - Maze currently being evolved.
+- `neat` - - Optional NEAT runtime instance used for detailed stats.
+
 ### resetDashboardState
 
 ```ts
@@ -254,29 +254,6 @@ telemetry helpers stay visually and semantically aligned.
 
 ## dashboardManager/dashboardManager.utils.ts
 
-### formatDashboardStat
-
-```ts
-formatDashboardStat(
-  label: string,
-  value: string | number,
-  colorLabel: string,
-  colorValue: string,
-  labelWidth: number,
-): string
-```
-
-Format a single framed dashboard stat line with aligned label and value columns.
-
-Parameters:
-- `label` - - Descriptive stat label.
-- `value` - - String or number value displayed after the label.
-- `colorLabel` - - Color token applied to the label segment.
-- `colorValue` - - Color token applied to the value segment.
-- `labelWidth` - - Fixed width used for the label column.
-
-Returns: Ready-to-log framed stat line.
-
 ### buildDashboardSparkline
 
 ```ts
@@ -294,21 +271,6 @@ Parameters:
 
 Returns: Unicode sparkline string.
 
-### getDashboardMazeKey
-
-```ts
-getDashboardMazeKey(
-  maze: string[],
-): string
-```
-
-Build a lightweight dedupe key for a maze layout.
-
-Parameters:
-- `maze` - - Maze rows in display order.
-
-Returns: Joined maze key used by the solved archive.
-
 ### computeDashboardPathMetrics
 
 ```ts
@@ -341,6 +303,44 @@ Parameters:
 
 Returns: Architecture string such as `6 - 8 - 4`, or `n/a` when unavailable.
 
+### formatDashboardStat
+
+```ts
+formatDashboardStat(
+  label: string,
+  value: string | number,
+  colorLabel: string,
+  colorValue: string,
+  labelWidth: number,
+): string
+```
+
+Format a single framed dashboard stat line with aligned label and value columns.
+
+Parameters:
+- `label` - - Descriptive stat label.
+- `value` - - String or number value displayed after the label.
+- `colorLabel` - - Color token applied to the label segment.
+- `colorValue` - - Color token applied to the value segment.
+- `labelWidth` - - Fixed width used for the label column.
+
+Returns: Ready-to-log framed stat line.
+
+### getDashboardMazeKey
+
+```ts
+getDashboardMazeKey(
+  maze: string[],
+): string
+```
+
+Build a lightweight dedupe key for a maze layout.
+
+Parameters:
+- `maze` - - Maze rows in display order.
+
+Returns: Joined maze key used by the solved archive.
+
 ### sliceDashboardHistoryForExport
 
 ```ts

package/test/examples/asciiMaze/dashboardManager/telemetry/README.md

@@ -21,66 +21,66 @@ A practical reading order is:
 
 ## dashboardManager/telemetry/dashboardManager.telemetry.services.ts
 
-### getDashboardLastTelemetry
+### createDetailedStatsSnapshot
 
 ```ts
-getDashboardLastTelemetry(
+createDetailedStatsSnapshot(
   state: DashboardManagerState,
-): AsciiMazeTelemetrySnapshot
+  neat: unknown,
+): AsciiMazeDetailedStats | null
 ```
 
-Produce the latest public telemetry snapshot from current dashboard state.
+Build the rich telemetry detail snapshot shown in browser hooks and exported snapshots.
 
 Parameters:
-- `state` - - Mutable dashboard state.
+- `state` - - Mutable dashboard state with histories and current best candidate.
+- `neat` - - Optional NEAT instance used for population-level telemetry.
 
-Returns: Public telemetry snapshot used by browser hosts.
+Returns: Detailed telemetry snapshot or `null` when no data is available.
 
-### updateTelemetryHistory
+### emitTelemetryPayload
 
 ```ts
-updateTelemetryHistory(
+emitTelemetryPayload(
   state: DashboardManagerState,
-  neatInstance: { getTelemetry?: (() => unknown[]) | undefined; } | undefined,
+  generation: number,
+  telemetryHook: ((payload: DashboardTelemetryPayload) => void) | undefined,
 ): void
 ```
 
-Pull the latest NEAT telemetry snapshot and update bounded dashboard histories.
+Emit the structured telemetry payload used by browser hosts and runtime hooks.
 
 Parameters:
-- `state` - - Mutable dashboard state that owns bounded histories.
-- `neatInstance` - - Optional NEAT-like runtime exposing `getTelemetry()`.
+- `state` - - Mutable dashboard state used to assemble the payload.
+- `generation` - - Current generation number.
+- `telemetryHook` - - Optional runtime hook installed by the browser host.
 
-### createDetailedStatsSnapshot
+### getDashboardLastTelemetry
 
 ```ts
-createDetailedStatsSnapshot(
+getDashboardLastTelemetry(
   state: DashboardManagerState,
-  neat: unknown,
-): AsciiMazeDetailedStats | null
+): AsciiMazeTelemetrySnapshot
 ```
 
-Build the rich telemetry detail snapshot shown in browser hooks and exported snapshots.
+Produce the latest public telemetry snapshot from current dashboard state.
 
 Parameters:
-- `state` - - Mutable dashboard state with histories and current best candidate.
-- `neat` - - Optional NEAT instance used for population-level telemetry.
+- `state` - - Mutable dashboard state.
 
-Returns: Detailed telemetry snapshot or `null` when no data is available.
+Returns: Public telemetry snapshot used by browser hosts.
 
-### emitTelemetryPayload
+### updateTelemetryHistory
 
 ```ts
-emitTelemetryPayload(
+updateTelemetryHistory(
   state: DashboardManagerState,
-  generation: number,
-  telemetryHook: ((payload: DashboardTelemetryPayload) => void) | undefined,
+  neatInstance: { getTelemetry?: (() => unknown[]) | undefined; } | undefined,
 ): void
 ```
 
-Emit the structured telemetry payload used by browser hosts and runtime hooks.
+Pull the latest NEAT telemetry snapshot and update bounded dashboard histories.
 
 Parameters:
-- `state` - - Mutable dashboard state used to assemble the payload.
-- `generation` - - Current generation number.
-- `telemetryHook` - - Optional runtime hook installed by the browser host.
+- `state` - - Mutable dashboard state that owns bounded histories.
+- `neatInstance` - - Optional NEAT-like runtime exposing `getTelemetry()`.