Files
gods-eye-view/src/mapStackChips.js
T
Sameh Khamis 0b8cb4f33f refactor(ui): remove the map stack chip DOM builders
The dock renders the chips from the map source controls' published view,
so renderMapStackChips, syncMapStackChips and MAP_STACK_CHIP_CLASS have no
callers. Their tests now pin the chip models; the dock test keeps the
rendered chips' button type and native enablement.
2026-10-31 19:28:02 -07:00

80 lines
3.5 KiB
JavaScript

// MAP STACK source chips — the always-visible replacement for the `<select>`
// that used to sit in the Map Stack panel. One chip model per stack, from
// `MapStackController.getStacks()`; the dock renders them. The approved sources
// below are the whole shipped set; keeping the allowlist explicit means a stack
// added to `MAP_STACKS` for another purpose cannot reach the tray until someone
// names it here.
//
// The chips are a control SURFACE only: selecting one calls
// `createMapSourceControls().select()`, the path `_setMapStack()` uses, and the
// active state is re-synced from controller state (never optimistically), so a
// failed or superseded switch still leaves the truly-active stack lit.
import { keySetupRequirementEnvVars } from './keySetupCore.mjs';
import { t } from './i18n/index.js';
export const PRESENTED_MAP_STACK_IDS = Object.freeze([
'photoreal',
'bing-aerial',
'bing-labels',
'esri-imagery',
'osm',
]);
/**
* Presentation model for one map-stack chip.
*
* Unavailable is NOT the same as needs-an-ion-token: `photoreal` is unavailable
* whenever the Google tileset failed to load (the startup fallback-to-OSM
* case), and a future stack may have its own reason. The ION badge is therefore
* gated on the stack's own `requiresIon` flag, and the tooltip quotes the
* controller's `unavailableReason` rather than assuming one.
* @param {{id: string, label: string, available?: boolean, requiresIon?: boolean, unavailableReason?: string|null}} stack - Stack descriptor from `getStacks()`.
* @param {string|null} activeId - Currently active stack id.
* @returns {{id: string, label: string, available: boolean, active: boolean, requiresIon: boolean, requirement: string, unavailableHint: string, title: string}}
*/
export function mapStackChipModel(stack, activeId) {
const available = stack?.available !== false;
const label = String(stack?.label ?? stack?.id ?? '');
const requiresIon = stack?.requiresIon === true;
// Stack labels are provider names and stay English; the sentence translates.
const fallbackReason = requiresIon
? t('Needs {envVars} — add it in Provider Settings', {
envVars: keySetupRequirementEnvVars('cesium-ion'),
})
: t('{label} is unavailable', {
label: label || t('This map stack'),
});
const unavailableHint = available
? ''
: String(stack?.unavailableReason || fallbackReason);
return {
id: String(stack?.id ?? ''),
label,
available,
active: !!stack?.id && stack.id === activeId,
requiresIon,
// Dropdown parity: unavailable options read "<label> · ion key". A chip has
// no room for that, so an ion-backed stack gets a compact badge; every
// unavailable chip carries the real reason in its tooltip.
requirement: !available && requiresIon ? 'ION' : '',
unavailableHint,
title: available ? label : unavailableHint,
};
}
/**
* @param {Array<object>} stacks - `MapStackController.getStacks()` output.
* @param {string|null} activeId - Currently active stack id.
* @returns {Array<object>} One chip model per approved presentation id, in
* `PRESENTED_MAP_STACK_IDS` order; unlisted stacks stay outside this presentation.
*/
export function mapStackChipModels(stacks, activeId) {
const stacksById = new Map(
(Array.isArray(stacks) ? stacks : []).map((stack) => [stack?.id, stack]),
);
return PRESENTED_MAP_STACK_IDS.map((id) => stacksById.get(id))
.filter(Boolean)
.map((stack) => mapStackChipModel(stack, activeId));
}