@kahwee/sf-map-svg 2.2.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/README.md +37 -624
  3. package/dist/data/README.md +3 -2
  4. package/dist/src/full-data.d.ts +3 -0
  5. package/dist/src/full-data.js +9 -0
  6. package/dist/src/guide-map.d.ts +1 -1
  7. package/dist/src/guide-map.js +4 -3
  8. package/dist/src/guide.d.ts +1 -2
  9. package/dist/src/map.d.ts +1 -1
  10. package/dist/src/map.js +5 -3
  11. package/dist/src/static-data.d.ts +3 -0
  12. package/dist/src/static-data.js +23 -0
  13. package/docs/EXAMPLES.md +11 -9
  14. package/docs/api-audit.md +5 -14
  15. package/docs/consumer-integration.md +12 -159
  16. package/docs/guide-bundle-report.md +5 -7
  17. package/docs/migration-v3.md +30 -0
  18. package/package.json +10 -22
  19. package/dist/src/custom-map.d.ts +0 -3
  20. package/dist/src/custom-map.js +0 -1
  21. package/dist/src/explorer.d.ts +0 -4
  22. package/dist/src/explorer.js +0 -30
  23. package/dist/src/index.d.ts +0 -12
  24. package/dist/src/index.js +0 -21
  25. package/dist/src/interactive-data.d.ts +0 -6
  26. package/dist/src/interactive-data.js +0 -7
  27. package/dist/src/interactive.d.ts +0 -4
  28. package/dist/src/interactive.js +0 -7
  29. package/docs/migration-v2.md +0 -238
package/CHANGELOG.md CHANGED
@@ -4,6 +4,23 @@ User-visible changes are recorded here. Unreleased entries describe changes on `
4
4
 
5
5
  ## Unreleased
6
6
 
7
+ ## 3.0.0 — 2026-09-27
8
+
9
+ Version 3 removes the deprecated compatibility APIs. Applications must migrate before upgrading. The data-free root API introduced in version 2 remains the supported API.
10
+
11
+ ### Breaking changes
12
+
13
+ - Remove the `/legacy`, `/custom-map`, `/explorer`, `/interactive`, and `/interactive-data` package entry points and their bundled-data factories. These imports fail to resolve in v3; they are removed, not merely marked deprecated.
14
+ - Replace `renderSFMap(options)` with `renderMap(fullMapData.map, options).svg`, `createSFMap(options)` with `renderMap(fullMapData.map, options)`, and `createSFMapWithData(options, data)` with `renderMap(data, options)`.
15
+ - Replace `createNeighborhoodExplorer(options)` and `createInteractiveSFMap(options)` with `createMap(fullMapData, options)`; mount the returned controller's `.element` and call `.destroy()` on unmount. Replace `createInteractiveSFMapWithData(data, options)` with `createMap(data, options)`.
16
+ - Import complete packaged geography explicitly from `/data/full`, or compose smaller data from `/data/*`. The root import continues to bundle no geography. Existing `/guide` and `/transit` entries remain available.
17
+
18
+ ### Migration and verification
19
+
20
+ - Add a [v3 migration guide](docs/migration-v3.md) with import and method mappings. Update README, runnable examples, Storybook, Pages generation, TypeScript contracts, and packed-consumer checks to use the supported API.
21
+ - Preserve the generated SVG output for the old complete-data preset while making that data an explicit import. Keep the guide's narrow overview and detailed-data loading.
22
+ - Add `/data/static` for the complete static map without interactive lookup collections; use it on the Pages spot explorer so its detailed coast and labels retain their reviewed appearance without pulling in unused collections.
23
+
7
24
  ## 2.2.0 — 2026-09-27
8
25
 
9
26
  - Add “One spot, three San Franciscos” to Pages and Storybook, comparing the same location across district, neighborhood, and transit views.