@kahwee/sf-map-svg 4.5.0 → 5.1.0

package/docs/EXAMPLES.md

@@ -105,3 +105,32 @@ API** includes executable motion, reduced-motion, and progressive-shell checks.
 See [consumer integration](consumer-integration.md) for server and browser recipes.
 
 For the controller and explicit data imports, see [the v3 migration guide](migration-v3.md).
+
+## Find areas containing a location
+
+New in v5. This example runs in
+Node or a browser without mounting a map and imports only the SFAR definition:
+
+```ts
+import { geometryBounds, geometryContainsPoint } from '@kahwee/sf-map-svg/geometry';
+import { neighborhoods } from '@kahwee/sf-map-svg/data/realtor';
+
+const location = [-122.42, 37.76] as const;
+const matches = neighborhoods.features.filter((feature) =>
+  geometryContainsPoint(feature.geometry, location),
+);
+for (const feature of matches) {
+  console.log(feature.id, feature.properties.canonicalName, geometryBounds(feature.geometry));
+}
+```
+
+Keep all matches when the location lies on a shared boundary. An empty result
+means no supplied polygon contains the location; it does not trigger a switch
+to another neighborhood definition. For an existing map using the same realtor
+source, pass a chosen match to
+`map.selectFeature({ kind: 'neighborhood', source: 'realtor', id: feature.id })`.
+To fit it, use `map.camera.fit(feature.geometry)`. Geographic bounds cannot be
+passed directly to `camera.set`, which takes projected `[x, y, size]`.
+
+See [query semantics and limitations](API.md#geographic-queries) and the
+[HTML overlay recipe](consumer-integration.md#position-html-overlays).

package/docs/api-audit.md

@@ -20,8 +20,8 @@ unbounded geographic data can never fail.
 | Viewport marker rendering | Individual pin visuals allocate on first visibility or selection; offscreen pins and cluster symbols detach with screen-space overscan. Uncreated records receive current labels/styles on first materialization. Full catalog/picker and cached node identities remain available; selected/focused pins stay mounted. Pan reuses global cluster membership and nodes until zoom, data, selection, focus, or clustering changes. |
 | Marker entrance and reduced motion | Entrances begin on first visibility, are independent of camera motion, and cancel on preference changes or disposal, including pending entrances. Cached pins do not restart entrances on reentry. Stable IDs avoid repeated entrances on filtering. |
 | Hiding touch control while gestures are enabled | Returns touch scrolling to the page. Other toolbar controls remain independent. |
-| Convenience mode/source setters | Share the atomic configuration path. `{ resetView: false }` preserves the camera; omitted options retain the historic reset. Invalid options and unavailable geography leave state unchanged. |
-| Runtime patch omitted/false/undefined | Omitted retains; false disables boolean switches; undefined removes group/key overrides. Top-level mode/source/year/labels set to undefined retain their current values. Nested feature objects replace, rather than deep-merge. |
+| Convenience mode/source setters | Share the atomic configuration path. Setters preserve the camera; explicit camera methods move it. Unavailable geography leaves state unchanged. |
+| Runtime patch omitted/false/undefined | Controller patches ignore omitted/undefined values at every record depth; false disables boolean switches. Nested feature records merge. Explicit resetConfiguration clears presentation groups. Low-level element setters retain their separate contract. |
 | Compact shell and full attribution | Rejected before replacement. Use `createGuideController` for full attribution. Control overrides are honored and may deliberately alter layout. |
 | District style callbacks | Prepare and copy every style before committing. Hover/selection reuse the results; call `setDistrictStyle()` to refresh changed external data. Reentrant updates or destruction supersede pending work. |
 | Rapid district year changes | Both outgoing layers are tracked, inert, and removed on interruption, completion, reduced-motion changes, or destruction. Zero duration creates no transition copies. |
@@ -58,15 +58,32 @@ exceptions are not transactional validation errors and do not roll back an alrea
 committed change. Direct mutation of the returned DOM can invalidate invariants;
 use the public methods and `overlayElement` extension point.
 
-Static grouped layers and appearance reject unknown keys, while flat compatibility options retain their existing surface; strict
-interactive option-key validation is not a claim that all static options share the
-same schema. Host layout, delayed images, fonts, and application cards need their
+Static flat and grouped options reject unknown keys and invalid values before
+rendering. Grouped options take precedence over flat compatibility options;
+static and interactive schemas retain their documented differences. Host layout, delayed images, fonts, and application cards need their
 own CLS tests. The scale bar is an approximate local Mercator scale, not survey
 instrumentation. Coincident locations use a place chooser rather than spiderfying. Geographic
 source correctness remains governed by SOURCES.md and existing topology tests.
 
 ## Extending the contract
 
+### V5 consistency contract
+
+- Geometry helpers export their input/result types alongside functions and use
+  geometry-first arguments with readonly GeoJSON positions.
+- Marker positions, static projection, and screen projection all use
+  `[longitude, latitude]`. Screen projection returns CSS pixels; camera viewports
+  remain projected map units and pan deltas remain CSS pixels.
+- Controller `configure`, `setMode`, and `setSource` preserve the camera. Camera
+  movement is explicit through camera methods or selection's `fit` option.
+- Controller patches ignore omitted/undefined values at every depth and merge
+  nested records. `resetConfiguration` clears named presentation groups to
+  built-in defaults without changing geographic choices or camera.
+- Controller neighborhood selection requires exact IDs. Prefer source/year-qualified
+  `selectFeature`; name lookup belongs in source-specific dataset helpers.
+- Construction-time neighborhood lookup and low-level element APIs retain their
+  separately documented contracts. See [v5 migration](migration-v5.md).
+
 For every new option, define its default, disable/reset semantics, precedence,
 validation boundary, cleanup owner, and effect on keyboard focus and selection.
 Test invalid updates against an existing live map, not only clean construction.

package/docs/consumer-integration.md

@@ -35,7 +35,7 @@ For a fixed-width embed, use shared inputs on the server and in the browser:
 ```ts
 // Shared inputs: coordinates, IDs, radii, colors and layer choices must match.
 const guideMarkers = [
-  { id: 'ferry', label: 'Ferry Building', lng: -122.3937, lat: 37.7955, radius: 7 },
+  { id: 'ferry', label: 'Ferry Building', position: [-122.3937, 37.7955] as const, radius: 7 },
 ];
 const guideLayers = { neighborhoodLabels: true, roadLabels: true };
 const guideColors = { label: '#183e58', landmark: '#426641' };
@@ -125,3 +125,49 @@ const binding = bindMapCards(map, document.querySelector('#place-cards'), {
 Style `[data-map-selected]` with an outline or background change that remains legible in both themes. Use a visible focus outline on card buttons and links. Hover/focus only previews the location: it preserves selection and camera. Map selection reveals the card without shifting keyboard focus; set `scrollOnSelect: false` if your application owns scrolling. Match cards and markers by stable IDs, and keep hidden/filtered places out of both catalogs when that is your intended filter behavior.
 
 Run `pnpm demo` and open `examples/generated/linked-cards.html` for the complete pattern. Storybook **Maps / Linked place cards** checks hover, keyboard selection, card reveal, both palettes, and disposal.
+
+## Position HTML overlays
+
+In v5, pass the same readonly `[longitude, latitude]` position used by static
+projection. The former two-number call is removed; see the
+[migration guide](migration-v5.md).
+
+Call this helper after mounting the map in a container with nonzero width:
+
+```ts
+import type { MapController } from '@kahwee/sf-map-svg';
+import type { Position } from '@kahwee/sf-map-svg/geometry';
+
+function attachCallout(map: MapController, location: Position, label: string) {
+  const callout = document.createElement('span');
+  callout.textContent = label;
+  callout.style.cssText = 'position:absolute;pointer-events:none;transform:translate(-50%,-100%)';
+  const update = () => {
+    const point = map.projectToScreen(location);
+    callout.hidden = !point.visible;
+    callout.style.left = `${point.x}px`;
+    callout.style.top = `${point.y}px`;
+  };
+  update();
+  map.overlayElement.append(callout);
+  const stopViewport = map.on('viewportchange', update);
+  const stopResize = map.on('mapresize', update);
+  return () => {
+    stopViewport();
+    stopResize();
+    callout.remove();
+  };
+}
+```
+
+Use `const detach = attachCallout(map, [-122.3937, 37.7955], 'Ferry Building')`
+with your mounted controller. Call `detach()` before `map.destroy()` on unmount.
+Keep the container visible while projecting; an unmounted or zero-width canvas
+throws. Controller calls after destruction also throw. Camera moves and resize
+both require repositioning; a one-time projection becomes stale.
+
+`x` and `y` are CSS pixels relative to `overlayElement`, not page coordinates or
+SVG units. `visible` tests inclusion in the map viewport; it does not account
+for occlusion by other content. This noninteractive label uses `textContent`
+and leaves pointer input to the map. Interactive callouts need their own
+keyboard, focus, and dismissal behavior. See [coordinates and units](API.md#coordinates-and-units).

package/docs/developer-guide.md

@@ -10,6 +10,7 @@ Choose the renderer and geography separately. `renderMap` produces a string with
 | Explore districts or several neighborhood definitions | `/map`: `createMap` | `/data/full`: `fullMapData` |
 | Embed a smaller neighborhood guide | `/guide/map`: `createGuideController` | Included lightweight guide geography |
 | Use the guide data with the general controller | `/map`: `createMap` | `/guide/data`: `guideMapData` |
+| Query bounds or polygon containment without a DOM | `/geometry` | Caller-supplied geometry or explicit dataset imports |
 | Look up names without mounting a map | `/data/lookup` | Source-aware lookup helpers |
 
 Imports starting with `/` in this table are package suffixes, such as `@kahwee/sf-map-svg/static`. Node 24+ is required for server rendering. Browser examples need a DOM and a bundler that supports JSON modules. This is an ESM package.
@@ -96,22 +97,43 @@ SFAR realtor neighborhoods are the default when supplied. If only an alternative
 | Camera | `map.camera.set/pan/zoom/fit/reset(...)` |
 | Palette, typography, control styling | `map.configure({ appearance })`; retains camera, selection and focus |
 
-Appearance token objects merge by key; `undefined` removes an override and `appearance: undefined` resets the group. Static maps accept grouped `layers` and the shared `appearance` keys (`theme`, `colors`, `districtStyle`) too. See [the API contract](API.md#live-configuration-and-inspection) and [the design playground](https://kahwee.github.io/sf-map-svg/playground.html).
-
-`configure` merges supplied keys; omitted keys keep their existing values. Set a layer or control key to `undefined` to remove its override. Set a whole group to `undefined` to reset that group. Set a feature to `false` to disable it. Explicit layer overrides keep winning after mode changes.
+Controller patches merge nested token and feature records. Omitted and `undefined`
+values retain existing values. Use `false` to disable a boolean switch and
+`resetConfiguration()` to clear presentation overrides explicitly:
 
 ```ts
 map.configure({ layers: { neighborhoodLabels: false } });
-map.configure({ layers: { neighborhoodLabels: undefined } }); // follow mode again
 map.configure({ features: { motion: false } });
-map.configure({ layers: undefined }); // clear all explicit layer overrides
+map.resetConfiguration(['layers']); // follow mode-derived defaults again
+map.resetConfiguration(['appearance']); // built-in palette and typography
 ```
 
-`getConfiguration()` returns current mode/source/year/labels and a detached snapshot of the presentation groups, including explicit layer and appearance overrides. Camera and selection remain separate runtime state. Use `getResolvedConfiguration()` for current mode/source/year/labels and effective layer switches, and `getCapabilities()` for supplied geography. Invalid configuration patches leave the current map unchanged. Convenience methods use the same atomic update path: pass `map.setMode(mode, { resetView: false })` or `map.setSource(source, { resetView: false })` to keep the camera. Their default still resets the view.
+Reset groups are `features`, `layers`, `controls`, and `appearance`; omitting
+the argument resets all four. Resets preserve geographic choices and camera,
+and do not restore constructor overrides. Static maps accept grouped layers and
+the shared appearance keys (`theme`, `colors`, `districtStyle`) at construction.
+See [the API contract](API.md#live-configuration-and-inspection).
+
+`getConfiguration()` returns a detached snapshot of geographic choices and
+presentation overrides. Use `getResolvedConfiguration()` for effective layers
+and `getCapabilities()` for supplied geography. Invalid patches preserve state.
+`setMode`, `setSource`, and `configure` all preserve the camera; request movement
+with `camera.reset()` or `camera.fit(geometry)`. See the
+[v5 migration guide](migration-v5.md) for changed call forms.
+
+## Geographic queries
+
+The v5 `/geometry` helpers `geometryBounds(geometry)` and
+`geometryContainsPoint(geometry, position)` work without a DOM or bundled
+geography. Import `Bounds`, `Geometry`, and `Position` types from the same entry.
+Use containment for area lookup and bounds for geographic extents; pass the
+original geometry to `camera.fit`, rather than geographic bounds to `camera.set`.
+See the [worked example](EXAMPLES.md#find-areas-containing-a-location) and
+[full query semantics](API.md#geographic-queries).
 
 ## Markers, routes and camera coordinates
 
-Marker positions are `{ lng, lat }`. GeoJSON coordinates and the static projection use `[longitude, latitude]`, in WGS84. Camera viewports use `[x, y, size]` in the fixed 800 × 800 projected map space; they are not geographic bounds. `camera.pan` uses projected units. `projectToScreen(lng, lat)` returns pixels relative to the map canvas, plus visibility.
+Markers use `position: [longitude, latitude]`. GeoJSON coordinates and the static projection use `[longitude, latitude]`, in WGS84. Camera viewports use `[x, y, size]` in the fixed 800 × 800 projected map space; they are not geographic bounds. `camera.pan` takes deltas in CSS pixels and converts them using the mounted canvas width. `projectToScreen([lng, lat])` returns CSS pixels relative to the map canvas, plus viewport visibility. The former two-number call is removed in v5.
 
 Marker and overlay IDs must be unique. Keep marker IDs stable across updates so retained markers preserve DOM nodes, focus and entrance animations. Use `null` to clear a selection; selection methods return a boolean. Selection events can contain null values. `map.on()` returns an unsubscribe function.
 

package/docs/guide-bundle-report.md

@@ -1,12 +1,12 @@
 # Guide bundle size report
 
-Generated 2026-10-14 by `pnpm report:guide` with Vite production minification and gzip compression. Each emitted JS chunk is compressed independently. The report measures the explicit-data root and the optional `@kahwee/sf-map-svg/guide` preset.
+Generated 2026-10-20 by `pnpm report:guide` with Vite production minification and gzip compression. Each emitted JS chunk is compressed independently. The report measures the explicit-data root and the optional `@kahwee/sf-map-svg/guide` preset.
 
 | Entry | Initial JS, raw | Initial JS, gzip | Explicit detail JS, gzip |
 | --- | ---: | ---: | ---: |
-| Renderer root (explicit data) | 122.8 KB | 36.3 KB | — |
-| Static renderer | 33.2 KB | 10.2 KB | — |
-| Guide preset | 507.0 KB | 122.1 KB | 467.0 KB |
+| Renderer root (explicit data) | 124.2 KB | 36.5 KB | — |
+| Static renderer | 33.4 KB | 10.3 KB | — |
+| Guide preset | 508.4 KB | 122.3 KB | 467.0 KB |
 
 **500 KB target:** met.
 

package/docs/migration-v5.md

@@ -0,0 +1,100 @@
+# Migrating to v5
+
+Version 5.0.0 makes coordinate inputs, controller updates, and reset behavior
+consistent. It requires Node 24+ and retains offline rendering, explicit data
+imports, zero runtime dependencies, and the existing default map appearance.
+The version bump prepares the next release; it does not publish the package.
+
+## Coordinates use GeoJSON positions
+
+Markers now require `position: [longitude, latitude]`. The old `lng` and `lat`
+properties are rejected. `projectToScreen` takes one readonly position; its
+old two-number form is removed. Altitude is accepted and ignored by projection.
+
+```ts
+// v4
+const oldMarker = { id: 'ferry', lng: -122.3937, lat: 37.7955 };
+// v5
+const marker = { id: 'ferry', position: [-122.3937, 37.7955] as const };
+map.setMarkers([marker]);
+const point = map.projectToScreen(marker.position);
+```
+
+Use `Position` from `/geometry` for reusable positions and `ScreenPoint` or
+`ProjectToScreen` from the root or `/map` for screen-projection contracts.
+`x` and `y` remain canvas-relative CSS pixels; `visible` means inside the
+viewport, not unobscured. Mount the map in a nonzero-width container first.
+Camera viewports still use projected `[x, y, size]`; camera pan deltas are CSS
+pixels. Geographic bounds are not camera viewports.
+
+## Controller updates preserve the camera
+
+`configure`, `setMode`, and `setSource` preserve the camera. The second
+`{ resetView }` argument to the controller convenience setters is removed.
+To reproduce an old automatic reset, request it explicitly:
+
+```ts
+map.setMode('neighborhoods');
+map.camera.reset({ animate: false });
+```
+
+Selection still fits by default. Use `{ fit: false }` to change selection
+without moving the camera, or `camera.fit(geometry)` for an explicit fit.
+
+## Reset presentation explicitly
+
+In controller `configure` patches, omitted and `undefined` values are no-ops at
+every record depth. Nested token and feature records merge; an explicit boolean
+replaces a feature record and `false` disables a boolean switch.
+
+```ts
+map.configure({ appearance: { colors: { water: '#142d45' } } });
+map.configure({ appearance: undefined }); // keeps the current appearance
+map.resetConfiguration(['appearance']); // restores built-in appearance defaults
+map.resetConfiguration(['layers', 'controls']); // removes explicit overrides
+map.resetConfiguration(); // resets all four presentation groups
+```
+
+The reset groups are `features`, `layers`, `controls`, and `appearance`.
+Resetting a group does not restore initial constructor overrides, change the
+camera, or change mode/source/year/labels. It restores built-in defaults and
+mode-derived layer choices. Supply geographic choices explicitly through
+`configure`. To remove a single token while retaining other overrides, build
+the desired group, reset that group, then configure the retained values.
+Each call commits atomically; the two calls are separate updates.
+
+These rules describe `MapController` from `createMap`, `createGuideController`,
+and `mountGuideController`. Low-level element factories retain their separate
+`setFeatures` / `setLayers` APIs; use controllers for the grouped update contract.
+
+## Select neighborhoods by exact identity
+
+Controller `selectNeighborhood(id)` accepts an exact ID in the current source,
+rather than a display name or alias. Unknown IDs return `false` without changing
+selection. Resolve a human-entered name using the source-specific lookup first.
+For integrations, prefer the source-qualified identity:
+
+```ts
+import { getRealtorNeighborhood } from '@kahwee/sf-map-svg/data/realtor';
+
+const feature = getRealtorNeighborhood('Inner Mission');
+if (feature) {
+  map.selectFeature({ kind: 'neighborhood', source: 'realtor', id: feature.id }, { fit: false });
+}
+```
+
+`selectFeature` requires the current supplied source/year and never switches
+geography implicitly. Marker IDs and numeric district IDs remain unchanged.
+The construction-time `neighborhood` option and low-level element lookup APIs
+continue to resolve names; the stricter ID contract applies to controller
+selection methods. Existing selection event names remain available alongside
+`selectionchange`.
+
+## Offline geometry queries
+
+`geometryBounds(geometry)` and `geometryContainsPoint(geometry, position)` are
+new in v5. They accept readonly GeoJSON without a DOM or geographic imports.
+Bounds are `[west, south, east, north]` or `null` for empty geometry. Containment
+respects holes, includes polygon boundaries, and supports islands and nested
+collections. Shared edges can match more than one feature. See the
+[query contract](API.md#geographic-queries) for validation and planar limitations.