@kahwee/sf-map-svg 4.4.0 → 4.5.0

package/llms-full.txt

@@ -2,13 +2,13 @@
 
 > Offline San Francisco SVG maps with explicit geographic imports, no runtime dependencies, static rendering, and a browser controller.
 
-@kahwee/sf-map-svg 4.4.0 · local working tree. Node >=24.0.0 for server rendering; browsers need a DOM and a JSON-capable bundler.
+@kahwee/sf-map-svg 4.5.0 · local working tree. Node >=24.0.0 for server rendering; browsers need a DOM and a JSON-capable bundler.
 
 These are working-tree docs. Unreleased changelog entries may describe APIs absent from npm; verify the installed version before copying them.
 
 Use renderMap(data, options) for SVG strings; createMap(data, options) returns a controller. Mount map.element and destroy it on unmount. Choose mode explicitly: createMap defaults to basemap. Geography is separate; staticMapData and fullMapData have different shapes.
 
-<!-- Generated from README.md; @kahwee/sf-map-svg 4.4.0 · local working tree. -->
+<!-- Generated from README.md; @kahwee/sf-map-svg 4.5.0 · local working tree. -->
 
 # SF Map SVG
 
@@ -220,7 +220,7 @@ pnpm benchmark:markers --counts=2000 --mode=neighborhoods \
 
 ---
 
-<!-- Generated from docs/developer-guide.md; @kahwee/sf-map-svg 4.4.0 · local working tree. -->
+<!-- Generated from docs/developer-guide.md; @kahwee/sf-map-svg 4.5.0 · local working tree. -->
 
 # Developer guide
 
@@ -364,7 +364,7 @@ See [API options](https://github.com/kahwee/sf-map-svg/blob/main/docs/API.md), [
 
 ---
 
-<!-- Generated from docs/API.md; @kahwee/sf-map-svg 4.4.0 · local working tree. -->
+<!-- Generated from docs/API.md; @kahwee/sf-map-svg 4.5.0 · local working tree. -->
 
 # Map options and lifecycle
 
@@ -399,8 +399,32 @@ The SVG description names the selected neighborhood source for source-aware data
 
 Static `labelLayout: { width: 390 }` opts into shared interactive **overview** label priorities, sizes, anchors and collision rules. `width` must be a positive finite CSS canvas width; it does not alter the SVG viewBox. Set `neighborhoodLabels: true` (flat or under `layers`) to add area names in this layout. Guide SVGs and shells enable neighborhood names by default only when opting into `labelLayout`. `labels: false` remains the master switch. Default static output is unchanged.
 
+For editorial previews, `labelLayout` also accepts `maxLabels` (a nonnegative safe integer), `haloColor` (an SVG color string), and `compact: { width, maxLabels }`. The compact width must be positive, finite, and smaller than the main layout width. Each layout places labels around pins independently, then chooses up to its budget for spatial coverage and nearby-pin context (selected marker first when it fits). Without a budget the existing overview order is unchanged. Equal spatial scores retain the original priority order. A zero budget hides text, never pins. The default halo remains white; use the land color for a quieter dark map.
+
+Compact mode embeds two label groups and a media query in the same SVG. At or below the compact width it shows the compact group; above it shows the main group. In an `<img>` or standalone SVG, the breakpoint follows the SVG viewport. In inline SVG it follows the document viewport, so use `<img>` for cards whose width differs from the page. No JavaScript, duplicated geometry, external fonts, or extra image requests are needed. The compact width is also its font-layout hint; very narrow images still scale the text. The interactive renderer continues to use its live collision layout after enhancement.
+
+```js
+createGuideSVG({
+  labelLayout: {
+    width: 800,
+    haloColor: '#1b2c28',
+    compact: { width: 480, maxLabels: 4 },
+  },
+  colors: { water: '#0a1412', land: '#1b2c28', label: '#d5e3e8' },
+  markers: places,
+});
+```
+
+See the [field-guide preview recipe](https://github.com/kahwee/sf-map-svg/blob/main/docs/consumer-integration.md#editorial-map-previews) for a complete build-time example.
+
 Static placement uses estimated system-font metrics without browser globals. Interactive placement measures actual fonts and includes live selection and HTML furniture, so exact glyph positions and the visible label set can differ. See the [integration recipe](https://github.com/kahwee/sf-map-svg/blob/main/docs/consumer-integration.md#keep-overview-labels-consistent) for width and progressive-enhancement guidance.
 
+## Editorial palettes
+
+Import `mapPalettes` from `@kahwee/sf-map-svg/presets`. `nightForest` and `warmPaper` are deeply frozen, opt-in token sets. Each supplies `colors`, `haloColor`, `markerColor`, `selectedMarkerColor`, and `selectedMarkerRingColor`. They work with any supplied geography and do not change the existing themes. Text clears 4.5:1 and pins/rings clear 3:1 against the palette's land, park, and water surfaces; consumers must check their own overrides and surrounding UI.
+
+For static maps pass `colors: palette.colors`, `labelLayout: { width: 800, haloColor: palette.haloColor }`, and the marker color on each marker. For interactive maps pass `appearance: { colors: palette.colors, labelStyle: { haloColor: palette.haloColor }, markerColor: palette.markerColor, selectedMarkerColor: palette.selectedMarkerColor }` and `features: { selectedMarkerRing: { color: palette.selectedMarkerRingColor } }`. Choose the palette in the consuming application; these tokens do not read system preferences or install global CSS.
+
 ## Interactive maps
 
 `createMap` defaults to `mode: 'basemap'` and `appearance.theme: 'transit'`. Set the mode explicitly for neighborhood or district exploration. District and neighborhood layer defaults follow the mode; other supplied layers default on. The [developer guide](https://github.com/kahwee/sf-map-svg/blob/main/docs/developer-guide.md) compares static and interactive defaults and explains configuration resets, coordinates, and cleanup.
@@ -478,9 +502,17 @@ GeoJSON and static projection inputs use `[longitude, latitude]` in WGS84; marke
 
 Explore presentation options in the [live map design playground](https://kahwee.github.io/sf-map-svg/playground.html). The page identifies its package version; released builds use compatible options for that installed version.
 
+## Linked place cards
+
+`bindMapCards(map, root, options)` from `@kahwee/sf-map-svg/cards` connects consumer-owned cards to a `MapController`. Each card uses `data-map-marker="stable-marker-id"`; native `<button type="button" data-map-select>` controls select that place without panning. Article links keep their ordinary navigation. `options.markers` is the same catalog supplied to the map; `highlightColor` optionally changes the preview ring and `scrollOnSelect: false` disables automatic card reveal.
+
+Pointer hover and keyboard focus draw a temporary ring through `projectToScreen()`. They do not call `selectMarker`, change the camera, or emit selection events. Focused cards take precedence over hovered cards. Offscreen points do not draw a ring. Touch users use the selection button. Selected cards receive `data-map-selected` and their buttons receive `aria-pressed`; style the card attribute in your own CSS. Selecting a pin reveals its card with immediate native scrolling, without moving focus. Filtering/reordering/removing cards is safe; IDs are compared directly, not inserted into CSS selectors.
+
+Call `binding.setMarkers(next)` after `map.setMarkers(next)` when the catalog changes. Call `binding.destroy()` before `map.destroy()` on unmount; cleanup is idempotent and restores attributes that the binding owned. The module does not create cards, fetch data, change URLs, install global CSS, or import geography. See the [linked-card recipe](https://github.com/kahwee/sf-map-svg/blob/main/docs/consumer-integration.md#link-place-cards-to-pins).
+
 ---
 
-<!-- Generated from docs/EXAMPLES.md; @kahwee/sf-map-svg 4.4.0 · local working tree. -->
+<!-- Generated from docs/EXAMPLES.md; @kahwee/sf-map-svg 4.5.0 · local working tree. -->
 
 # Examples
 
@@ -592,7 +624,7 @@ For the controller and explicit data imports, see [the v3 migration guide](https
 
 ---
 
-<!-- Generated from docs/consumer-integration.md; @kahwee/sf-map-svg 4.4.0 · local working tree. -->
+<!-- Generated from docs/consumer-integration.md; @kahwee/sf-map-svg 4.5.0 · local working tree. -->
 
 # Embedding and progressive enhancement
 
@@ -647,7 +679,7 @@ const labeledPlacesMarkup = createGuideShell({
 
 After inserting that markup, pass `markers: guideMarkers`, `layers: guideLayers`, and `appearance: { colors: guideColors }` to `mountGuideController()` as shown below. The static-only `labelLayout` option is not a browser option: the controller measures the actual canvas and font. The shell border is outside the canvas, so a default shell with a 390 px outer width has a 388 px canvas.
 
-For responsive layouts whose canvas width is unknown at build time, choose a representative width and accept text scaling until enhancement, or serve independently rendered SVG variants through your application's responsive markup. The package does not detect a device on the server. Keep `labels: false` if your design requires no visible text change at enhancement.
+For responsive layouts whose canvas width is unknown at build time, use `labelLayout.compact` for an embedded image with two static label layouts (see [editorial previews](#editorial-map-previews)), choose a representative width and accept text scaling until enhancement, or serve independently rendered SVG variants through your application's responsive markup. The package does not detect a device on the server. Keep `labels: false` if your design requires no visible text change at enhancement.
 
 For `renderMap()`, also enable `neighborhoodLabels` explicitly; it defaults off outside the guide preset. `labels: false` hides all text in either layout while preserving symbols and accessible titles.
 
@@ -684,9 +716,47 @@ For a new browser-only guide, use `createGuideController()` and mount its `.elem
 
 See the [exact API contract](https://github.com/kahwee/sf-map-svg/blob/main/docs/API.md), [worked examples](https://github.com/kahwee/sf-map-svg/blob/main/docs/EXAMPLES.md), and [bundle measurements](https://github.com/kahwee/sf-map-svg/blob/main/docs/guide-bundle-report.md).
 
+
+## Editorial map previews
+
+YorkSF uses one city overview to connect its field notes and compact locator maps to orient individual articles. These patterns work for any local guide: keep the place catalog in the consuming application, generate SVG images at build time, and link each preview to the application's map or article route.
+
+Run `pnpm demo` and open `examples/generated/field-guide.html` for a self-contained light/dark example. Its overview uses `labelLayout.compact` to limit mobile text without removing pins, and `haloColor` to match the night palette. The locator cards share those colors but omit labels at small sizes. Images reserve their aspect ratio and load lazily; the links work without JavaScript. The example derives its sample park coordinates from the package's existing landmark data rather than maintaining another geographic dataset.
+
+Use stable marker IDs for deep links. Keep addresses, visit dates, historical-status caveats, and editorial descriptions in your own content model. The package supplies map graphics; it does not imply that a place is currently open or that an author visited it. Keep a visible list beside the overview so the image is not the only way to find a place. SVG alt text should describe its purpose; link text should name the destination.
+
+For an image card, `compact.width` follows the image's rendered viewport. For inline SVG it follows the outer document viewport; do not assume it behaves like a container query. Avoid embedding scripts in exported images. Interactive maps remain a separate progressive enhancement.
+
+## Link place cards to pins
+
+Keep ordinary article links and add a separate map-selection button. Native buttons give keyboard and touch users the same action as pointer users:
+
+```html
+<article data-map-marker="park">
+  <h2><a href="/places/park/">A place in the park</a></h2>
+  <button type="button" data-map-select>Show on map</button>
+</article>
+```
+
+```js
+import { bindMapCards } from '@kahwee/sf-map-svg/cards';
+import { mapPalettes } from '@kahwee/sf-map-svg/presets';
+
+const binding = bindMapCards(map, document.querySelector('#place-cards'), {
+  markers: places,
+  highlightColor: mapPalettes.nightForest.selectedMarkerRingColor,
+});
+// On catalog change: map.setMarkers(next); binding.setMarkers(next);
+// On unmount: binding.destroy(); map.destroy();
+```
+
+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.
+
 ---
 
-<!-- Generated from docs/migration-v3.md; @kahwee/sf-map-svg 4.4.0 · local working tree. -->
+<!-- Generated from docs/migration-v3.md; @kahwee/sf-map-svg 4.5.0 · local working tree. -->
 
 # Migrate to version 3
 
@@ -727,7 +797,7 @@ District styles are now prepared once per district on construction and style/yea
 
 ---
 
-<!-- Generated from SOURCES.md; @kahwee/sf-map-svg 4.4.0 · local working tree. -->
+<!-- Generated from SOURCES.md; @kahwee/sf-map-svg 4.5.0 · local working tree. -->
 
 # Geometry and provenance
 
@@ -911,7 +981,7 @@ display geometry, and no precinct polygons or raw workbook data are shipped.
 
 ---
 
-<!-- Generated from CHANGELOG.md; @kahwee/sf-map-svg 4.4.0 · local working tree. -->
+<!-- Generated from CHANGELOG.md; @kahwee/sf-map-svg 4.5.0 · local working tree. -->
 
 # Changelog
 
@@ -919,6 +989,20 @@ User-visible changes are recorded here. Unreleased entries describe changes on `
 
 ## Unreleased
 
+## 4.5.0 — 2026-10-14
+
+- Add the optional `/cards` entry with `bindMapCards()`: hover/focus previews a pin without changing selection or camera, native buttons select places, map selection reveals matching cards without stealing focus, and explicit cleanup restores owned DOM attributes.
+- Spread budgeted static labels across the map while favoring nearby-pin context and retaining a selected-place label when it fits. Keep collision avoidance, all pins, unbudgeted labels, and default output unchanged.
+
+- Add opt-in `mapPalettes.nightForest` and `mapPalettes.warmPaper` tokens for consistent static/interactive map colors, label halos, markers, and selection rings, with contrast checks.
+
+- Port YorkSF’s editorial map-preview pattern into static rendering: opt-in compact SVG label layouts, spatial label budgets, and configurable halos for dark palettes. Add a build-time field-guide example and light/dark Storybook preview without runtime dependencies or changes to default output.
+
+- Separate interactive neighborhood state, controls, sidebar downloads and overlays into lifecycle-owned modules; revoke neighborhood hover listeners when replacing sources and keep optional explorer sidebar code out of normal map bundles.
+- Build the package once during `pnpm check`, while keeping standalone test and typecheck commands self-contained.
+
+- Include compatible development-tool updates to Vite 8.3.4 and Playwright 1.64.0. Keep Storybook/addons 10.6.1 and aligned Vitest/browser/coverage 5.0.3; their newer 10.6.2 and 5.0.4 releases remain inside pnpm's release-age window. Make the consumer examples' custom touch-button accessible names include their visible text. Remove the obsolete Storybook 10.6.0 peer overrides; retain Node 24+ and zero runtime dependencies. These tooling changes were previously prepared as 4.4.1 but not published separately.
+
 ## 4.4.0 — 2026-10-12
 
 - Add opt-in static `labelLayout: { width }` to `renderMap`, `createGuideSVG`, and `createGuideShell`. Static and interactive maps now share overview priorities, neighborhood anchors, font sizes, and collision rules; centered labels retain their anchors during enhancement.
@@ -1263,7 +1347,7 @@ consistent home, and makes animation and subscription ownership predictable.
 
 # Published type contracts
 
-@kahwee/sf-map-svg 4.4.0 · local working tree. These declarations are generated by TypeScript. Use package export paths, not the internal filenames below. Imported relative contracts are included for context, not as additional public entry points.
+@kahwee/sf-map-svg 4.5.0 · local working tree. These declarations are generated by TypeScript. Use package export paths, not the internal filenames below. Imported relative contracts are included for context, not as additional public entry points.
 
 | Public import | Declaration |
 | --- | --- |
@@ -1292,6 +1376,7 @@ consistent home, and makes animation and subscription ownership predictable.
 | @kahwee/sf-map-svg/map | ./dist/src/map.d.ts |
 | @kahwee/sf-map-svg/static | ./dist/src/static.d.ts |
 | @kahwee/sf-map-svg/presets | ./dist/src/presets.d.ts |
+| @kahwee/sf-map-svg/cards | ./dist/src/cards.d.ts |
 
 ### ./dist/src/api.d.ts
 
@@ -1691,6 +1776,15 @@ export interface SFMapOptions {
     /** Opt into interactive overview label priorities/collisions at this CSS display width. Uses estimated system-font metrics without a DOM. */
     labelLayout?: {
         width: number;
+        /** Maximum placed labels, spread across the map with nearby-pin context; zero hides text only. */
+        maxLabels?: number;
+        /** Label outline color, for example the land color on a dark map. */
+        haloColor?: string;
+        /** Alternate layout below this SVG viewport width, without browser JavaScript. */
+        compact?: {
+            width: number;
+            maxLabels: number;
+        };
     };
     highways?: boolean;
     keyRoads?: boolean;
@@ -2278,4 +2372,78 @@ export declare function createGuideShell(options?: SFMapOptions): string;
 import type { MapOptions } from './controller-types.js';
 /** Configuration only: pair with guide/data or a compatible caller-supplied dataset. */
 export declare const guideOptions: Readonly<MapOptions>;
+export { type MapPalette, mapPalettes } from './palettes.js';
+```
+
+### dist/src/palettes.d.ts
+
+```ts
+import type { SFMapOptions } from './types.js';
+/** Shared tokens for static SVGs, interactive maps, and consumer-owned place cards. */
+export interface MapPalette {
+    readonly colors: NonNullable<SFMapOptions['colors']>;
+    readonly haloColor: string;
+    readonly markerColor: string;
+    readonly selectedMarkerColor: string;
+    readonly selectedMarkerRingColor: string;
+}
+/** Opt-in editorial palettes inspired by YorkSF. Existing renderer themes stay unchanged. */
+export declare const mapPalettes: {
+    nightForest: {
+        colors: {
+            water: string;
+            land: string;
+            park: string;
+            neighborhood: string;
+            district: string;
+            road: string;
+            highway: string;
+            landmark: string;
+            bart: string;
+            label: string;
+        };
+        haloColor: string;
+        markerColor: string;
+        selectedMarkerColor: string;
+        selectedMarkerRingColor: string;
+    };
+    warmPaper: {
+        colors: {
+            water: string;
+            land: string;
+            park: string;
+            neighborhood: string;
+            district: string;
+            road: string;
+            highway: string;
+            landmark: string;
+            bart: string;
+            label: string;
+        };
+        haloColor: string;
+        markerColor: string;
+        selectedMarkerColor: string;
+        selectedMarkerRingColor: string;
+    };
+};
+```
+
+### ./dist/src/cards.d.ts
+
+```ts
+import type { MapController } from './controller-types.js';
+import type { MapMarker } from './types.js';
+export interface MapCardsOptions {
+    markers: readonly MapMarker[];
+    highlightColor?: string;
+    /** Reveal selected cards with native scrolling, without moving keyboard focus. Default true. */
+    scrollOnSelect?: boolean;
+}
+/** Connect consumer-owned [data-map-marker] cards and [data-map-select] buttons to a map. */
+export declare function bindMapCards(map: MapController, root: HTMLElement, options: MapCardsOptions): {
+    /** Call after map.setMarkers() when your place catalog changes. */
+    setMarkers(next: readonly MapMarker[]): void;
+    /** Remove owned listeners/decoration and restore card attributes. Call before map.destroy(). */
+    destroy(): void;
+};
 ```

package/llms.txt

@@ -2,7 +2,7 @@
 
 > Offline San Francisco SVG maps with explicit geographic imports, no runtime dependencies, static rendering, and a browser controller.
 
-@kahwee/sf-map-svg 4.4.0 · local working tree. Node >=24.0.0 for server rendering; browsers need a DOM and a JSON-capable bundler.
+@kahwee/sf-map-svg 4.5.0 · local working tree. Node >=24.0.0 for server rendering; browsers need a DOM and a JSON-capable bundler.
 
 These are working-tree docs. Unreleased changelog entries may describe APIs absent from npm; verify the installed version before copying them.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kahwee/sf-map-svg",
-  "version": "4.4.0",
+  "version": "4.5.0",
   "description": "Offline SVG maps of San Francisco with district boundaries, parks, landmarks, and BART stations.",
   "type": "module",
   "main": "./dist/src/api.js",
@@ -107,6 +107,10 @@
     "./presets": {
       "types": "./dist/src/presets.d.ts",
       "import": "./dist/src/presets.js"
+    },
+    "./cards": {
+      "types": "./dist/src/cards.d.ts",
+      "import": "./dist/src/cards.js"
     }
   },
   "files": [
@@ -143,13 +147,13 @@
     "@vitest/browser-playwright": "^5.0.3",
     "@vitest/coverage-v8": "5.0.3",
     "@xmldom/xmldom": "^0.9.12",
-    "playwright": "^1.63.0",
+    "playwright": "^1.64.0",
     "polygon-clipping": "^0.15.7",
     "react": "^19.3.0",
     "react-dom": "^19.3.0",
     "storybook": "^10.6.1",
     "typescript": "^7.0.2",
-    "vite": "^8.3.3",
+    "vite": "^8.3.4",
     "vitest": "^5.0.3"
   },
   "homepage": "https://kahwee.github.io/sf-map-svg/",
@@ -168,7 +172,8 @@
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
-    "test": "pnpm build && node --test",
+    "test": "pnpm build && pnpm test:built",
+    "test:built": "node --test",
     "test:stories": "pnpm build && vitest run --project=storybook",
     "test:stories:coverage": "pnpm build && vitest run --project=storybook --coverage",
     "test:visual": "playwright test --config=playwright.visual.config.mjs",
@@ -178,14 +183,17 @@
     "demo": "pnpm build && node examples/build.mjs",
     "format": "biome check --write .",
     "format:check": "biome format .",
-    "check": "pnpm peers check && pnpm lint && pnpm check:docs && pnpm data:check && pnpm typecheck && pnpm typecheck:stories && pnpm typecheck:website && pnpm test && pnpm test:bundle",
-    "check:docs": "pnpm build && node scripts/check-docs.mjs && node scripts/build-llm-docs.mjs --check",
+    "check": "pnpm peers check && pnpm lint && pnpm build && pnpm check:docs:built && pnpm data:check && pnpm typecheck:built && pnpm typecheck:stories && pnpm typecheck:website:built && pnpm test:built && pnpm test:bundle",
+    "check:docs": "pnpm build && pnpm check:docs:built",
+    "check:docs:built": "node scripts/check-docs.mjs && node scripts/build-llm-docs.mjs --check",
     "storybook": "pnpm build && storybook dev -p 6006 --host 127.0.0.1 --no-open",
     "build-storybook": "pnpm build && storybook build",
     "data:catalog": "node scripts/build-data-catalog.mjs",
     "data:check": "node scripts/build-data-catalog.mjs --check",
-    "typecheck": "pnpm build && tsc -p tsconfig.json",
-    "typecheck:website": "pnpm build && tsc -p tsconfig.website.json",
+    "typecheck": "pnpm build && pnpm typecheck:built",
+    "typecheck:built": "tsc -p tsconfig.json",
+    "typecheck:website": "pnpm build && pnpm typecheck:website:built",
+    "typecheck:website:built": "tsc -p tsconfig.website.json",
     "typecheck:stories": "tsc -p tsconfig.stories.json",
     "data:normalize-realtor": "node scripts/normalize-realtor.mjs",
     "data:guide": "node scripts/build-guide-data.mjs",