@kahwee/sf-map-svg 4.0.0 → 4.1.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 (40) hide show
  1. package/CHANGELOG.md +28 -1
  2. package/README.md +7 -9
  3. package/dist/data/guide/coast.json +1 -1
  4. package/dist/data/guide/landmarks.json +1 -1
  5. package/dist/data/guide/neighborhoods-realtor.json +1 -1
  6. package/dist/data/stations.d.ts +2 -2
  7. package/dist/data/types.d.ts +8 -1
  8. package/dist/src/api.d.ts +1 -1
  9. package/dist/src/api.js +1 -1
  10. package/dist/src/configuration.js +18 -2
  11. package/dist/src/controller-types.d.ts +1 -0
  12. package/dist/src/district-morph.d.ts +17 -0
  13. package/dist/src/district-morph.js +148 -0
  14. package/dist/src/explorer-core.js +143 -46
  15. package/dist/src/features.d.ts +6 -0
  16. package/dist/src/features.js +11 -1
  17. package/dist/src/frame-scheduler.d.ts +11 -0
  18. package/dist/src/frame-scheduler.js +64 -0
  19. package/dist/src/layer-transition.d.ts +18 -0
  20. package/dist/src/layer-transition.js +102 -0
  21. package/dist/src/layers.d.ts +9 -7
  22. package/dist/src/layers.js +28 -18
  23. package/dist/src/map-core.js +7 -4
  24. package/dist/src/marker-layer.d.ts +3 -0
  25. package/dist/src/marker-layer.js +27 -5
  26. package/dist/src/overlays.d.ts +3 -4
  27. package/dist/src/overlays.js +5 -1
  28. package/dist/src/static-animation.d.ts +13 -0
  29. package/dist/src/static-animation.js +36 -0
  30. package/dist/src/transit.js +2 -1
  31. package/dist/src/types.d.ts +26 -0
  32. package/dist/src/validation.js +2 -0
  33. package/docs/API.md +33 -0
  34. package/docs/api-audit.md +2 -0
  35. package/docs/consumer-integration.md +1 -1
  36. package/docs/developer-guide.md +137 -0
  37. package/docs/guide-bundle-report.md +4 -4
  38. package/llms-full.txt +1844 -0
  39. package/llms.txt +25 -0
  40. package/package.json +10 -4
package/llms.txt ADDED
@@ -0,0 +1,25 @@
1
+ # SF Map SVG
2
+
3
+ > Offline San Francisco SVG maps with explicit geographic imports, no runtime dependencies, static rendering, and a browser controller.
4
+
5
+ @kahwee/sf-map-svg 4.1.0 · local working tree. Node >=24.0.0 for server rendering; browsers need a DOM and a JSON-capable bundler.
6
+
7
+ These are working-tree docs. Unreleased changelog entries may describe APIs absent from npm; verify the installed version before copying them.
8
+
9
+ 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.
10
+
11
+ ## Documentation
12
+
13
+ - [Overview](https://kahwee.github.io/sf-map-svg/index.md)
14
+ - [Developer guide](https://kahwee.github.io/sf-map-svg/developer-guide.md)
15
+ - [API options and lifecycle](https://kahwee.github.io/sf-map-svg/api-options.md)
16
+ - [Worked examples](https://kahwee.github.io/sf-map-svg/examples.md)
17
+ - [Consumer integration](https://kahwee.github.io/sf-map-svg/consumer-integration.md)
18
+ - [Migration from removed APIs](https://kahwee.github.io/sf-map-svg/migration-v3.md)
19
+ - [Exact TypeScript contracts](https://kahwee.github.io/sf-map-svg/types.md)
20
+ - [Complete documentation](https://kahwee.github.io/sf-map-svg/llms-full.txt): Guides and declarations in one file.
21
+
22
+ ## Optional
23
+
24
+ - [Geographic sources](https://kahwee.github.io/sf-map-svg/sources.md)
25
+ - [Changelog](https://kahwee.github.io/sf-map-svg/changelog.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kahwee/sf-map-svg",
3
- "version": "4.0.0",
3
+ "version": "4.1.0",
4
4
  "description": "Offline SVG maps of San Francisco with district boundaries, parks, landmarks, and BART stations.",
5
5
  "type": "module",
6
6
  "main": "./dist/src/api.js",
@@ -119,7 +119,11 @@
119
119
  "docs/api-audit.md",
120
120
  "docs/guide-bundle-report.md",
121
121
  "docs/migration-v3.md",
122
- "CHANGELOG.md"
122
+ "CHANGELOG.md",
123
+ "docs/API.md",
124
+ "docs/developer-guide.md",
125
+ "llms.txt",
126
+ "llms-full.txt"
123
127
  ],
124
128
  "sideEffects": false,
125
129
  "repository": {
@@ -172,7 +176,7 @@
172
176
  "format": "biome check --write .",
173
177
  "format:check": "biome format .",
174
178
  "check": "pnpm peers check && pnpm lint && pnpm check:docs && pnpm data:check && pnpm typecheck && pnpm typecheck:stories && pnpm test && pnpm test:bundle",
175
- "check:docs": "node scripts/check-docs.mjs",
179
+ "check:docs": "pnpm build && node scripts/check-docs.mjs && node scripts/build-llm-docs.mjs --check",
176
180
  "storybook": "pnpm build && storybook dev -p 6006 --host 127.0.0.1 --no-open",
177
181
  "build-storybook": "pnpm build && storybook build",
178
182
  "data:catalog": "node scripts/build-data-catalog.mjs",
@@ -189,6 +193,8 @@
189
193
  "build:pages": "pnpm build && node scripts/build-pages.mjs",
190
194
  "test:bundle": "node scripts/report-guide-bundle.mjs --check",
191
195
  "test:pages": "node scripts/check-pages.mjs",
192
- "release:notes": "node scripts/release-notes.mjs"
196
+ "test:studio": "node visual/studio-loading.browser.mjs",
197
+ "release:notes": "node scripts/release-notes.mjs",
198
+ "docs:llms": "pnpm build && node scripts/build-llm-docs.mjs"
193
199
  }
194
200
  }