|
| 1 | +/* |
| 2 | +Toolbox Aid |
| 3 | +David Quesenberry |
| 4 | +04/16/2026 |
| 5 | +Phase19OverlayExpansionFramework.test.mjs |
| 6 | +*/ |
| 7 | +import assert from 'node:assert/strict'; |
| 8 | +import { LEVEL17_OVERLAY_CYCLE_KEY } from '../../samples/phase-17/shared/overlayCycleInput.js'; |
| 9 | +import { |
| 10 | + renderOverlayGameplayRuntime, |
| 11 | + stepOverlayGameplayRuntime, |
| 12 | +} from '../../samples/phase-17/shared/overlayGameplayRuntime.js'; |
| 13 | +import createPhase19OverlayExpansionFramework, { |
| 14 | + definePhase19OverlayExtension, |
| 15 | +} from '../../samples/phase-19/shared/overlay/createPhase19OverlayExpansionFramework.js'; |
| 16 | + |
| 17 | +function createRendererProbe(width = 960, height = 540) { |
| 18 | + return { |
| 19 | + getCanvasSize() { |
| 20 | + return { width, height }; |
| 21 | + }, |
| 22 | + clear() {}, |
| 23 | + drawRect() {}, |
| 24 | + strokeRect() {}, |
| 25 | + drawText() {}, |
| 26 | + drawLine() {}, |
| 27 | + drawPolygon() {}, |
| 28 | + drawImageFrame() {}, |
| 29 | + }; |
| 30 | +} |
| 31 | + |
| 32 | +function assertExpansionRegistrationAndCompatibility() { |
| 33 | + const counters = { step: 0, render: 0 }; |
| 34 | + const framework = createPhase19OverlayExpansionFramework(); |
| 35 | + const extension = framework.registerExtension(definePhase19OverlayExtension({ |
| 36 | + id: 'phase19-overlay-example', |
| 37 | + overlays: [ |
| 38 | + { id: 'hud', label: 'HUD' }, |
| 39 | + { id: 'runtime', label: 'Runtime Diagnostics' }, |
| 40 | + ], |
| 41 | + initialOverlayId: 'hud', |
| 42 | + persistenceKey: 'phase19:example:overlay-index', |
| 43 | + runtimeExtensions: [ |
| 44 | + { |
| 45 | + overlayId: 'runtime', |
| 46 | + compose: true, |
| 47 | + layerOrder: 10, |
| 48 | + panelWidth: 220, |
| 49 | + panelHeight: 88, |
| 50 | + onStep() { |
| 51 | + counters.step += 1; |
| 52 | + }, |
| 53 | + onRender() { |
| 54 | + counters.render += 1; |
| 55 | + }, |
| 56 | + }, |
| 57 | + ], |
| 58 | + metadata: { |
| 59 | + source: 'runtime-test', |
| 60 | + }, |
| 61 | + })); |
| 62 | + |
| 63 | + assert.equal(extension.channel, 'gameplay', 'Phase 19 overlay extension should default to gameplay channel.'); |
| 64 | + assert.equal(extension.cycleKey, LEVEL17_OVERLAY_CYCLE_KEY, 'Phase 19 extension should stay compatible with shared cycle key.'); |
| 65 | + assert.equal(extension.metadata.phase, '19', 'Phase 19 extension metadata should include phase identifier.'); |
| 66 | + assert.deepEqual(framework.listExtensionIds(), ['phase19-overlay-example'], 'Extension registration should expose exact extension id.'); |
| 67 | + |
| 68 | + const controllerConfig = framework.getControllerConfig('phase19-overlay-example'); |
| 69 | + assert.notEqual(controllerConfig, null, 'Controller config should resolve for registered extension.'); |
| 70 | + assert.equal(controllerConfig.initialOverlayId, 'hud', 'Controller config should preserve initial overlay id.'); |
| 71 | + assert.deepEqual( |
| 72 | + controllerConfig.overlays.map((entry) => entry.id), |
| 73 | + ['hud', 'runtime'], |
| 74 | + 'Controller config should expose expected overlay map.' |
| 75 | + ); |
| 76 | + |
| 77 | + const runtime = framework.createRuntimeForExtension('phase19-overlay-example'); |
| 78 | + assert.notEqual(runtime, null, 'Runtime should be creatable from registered overlay extension.'); |
| 79 | + assert.equal(runtime.interactionCycleKey, LEVEL17_OVERLAY_CYCLE_KEY, 'Runtime cycle key should remain shared-key compatible.'); |
| 80 | + assert.equal( |
| 81 | + stepOverlayGameplayRuntime(runtime, { activeOverlayId: 'runtime' }), |
| 82 | + 1, |
| 83 | + 'Runtime should execute registered step extension hook.' |
| 84 | + ); |
| 85 | + assert.equal( |
| 86 | + renderOverlayGameplayRuntime(runtime, { |
| 87 | + activeOverlayId: 'runtime', |
| 88 | + renderer: createRendererProbe(), |
| 89 | + }), |
| 90 | + 1, |
| 91 | + 'Runtime should execute registered render extension hook.' |
| 92 | + ); |
| 93 | + assert.equal(counters.step, 1, 'Runtime step hook should update test counter.'); |
| 94 | + assert.equal(counters.render, 1, 'Runtime render hook should update test counter.'); |
| 95 | +} |
| 96 | + |
| 97 | +function assertExtensionLifecycleMutations() { |
| 98 | + const framework = createPhase19OverlayExpansionFramework({ |
| 99 | + extensions: [ |
| 100 | + definePhase19OverlayExtension({ |
| 101 | + id: 'phase19-overlay-seed', |
| 102 | + overlays: [{ id: 'seed', label: 'Seed' }], |
| 103 | + }), |
| 104 | + ], |
| 105 | + }); |
| 106 | + |
| 107 | + assert.equal(framework.listExtensions().length, 1, 'Seed extension should be registered from constructor input.'); |
| 108 | + assert.equal(framework.unregisterExtension('phase19-overlay-seed'), true, 'Registered extension should be removable.'); |
| 109 | + assert.equal(framework.unregisterExtension('phase19-overlay-seed'), false, 'Removing missing extension should return false.'); |
| 110 | + assert.equal(framework.getControllerConfig('phase19-overlay-seed'), null, 'Removed extension should no longer resolve controller config.'); |
| 111 | + assert.equal(framework.createRuntimeForExtension('phase19-overlay-seed'), null, 'Removed extension should no longer create runtime.'); |
| 112 | +} |
| 113 | + |
| 114 | +export function run() { |
| 115 | + assertExpansionRegistrationAndCompatibility(); |
| 116 | + assertExtensionLifecycleMutations(); |
| 117 | +} |
0 commit comments