@classic-homes/theme-mcp 0.1.22 → 0.1.24

package/dist/cli.js

@@ -18002,6 +18002,42 @@ var maps_catalog_default = {
               description: "Serialize a filter expression for comparison"
             }
           ]
+        },
+        basemaps: {
+          description: "Basemap registry, presets, and utilities for basemap switching",
+          functions: [
+            {
+              name: "resolveBasemapStyle",
+              signature: "(basemap: BasemapDefinition, apiKeys?: BasemapApiKeys) => string | StyleSpecification | null",
+              description: "Resolve a basemap's style spec, injecting API key if needed. Returns null if required key is missing."
+            },
+            {
+              name: "getAvailableBasemaps",
+              signature: "(basemaps: BasemapDefinition[], apiKeys?: BasemapApiKeys) => BasemapDefinition[]",
+              description: "Filter basemaps to only those with available API keys. Free basemaps always included."
+            },
+            {
+              name: "resolveBasemapThumbnail",
+              signature: "(basemap: BasemapDefinition, apiKeys?: BasemapApiKeys) => string",
+              description: "Resolve thumbnail URL, appending provider-specific API key query parameter if needed."
+            }
+          ],
+          constants: [
+            { name: "FREE_BASEMAPS", type: "BasemapDefinition[]", description: "3 free basemaps: OSM Standard, Classic Light, Classic Dark (no API key required)" },
+            { name: "BUILTIN_BASEMAPS", type: "BasemapDefinition[]", description: "All 12 built-in basemaps including MapTiler (4) and Stadia Maps (5) options" },
+            { name: "OSM_STANDARD", type: "BasemapDefinition", description: "OpenStreetMap raster tiles (free)" },
+            { name: "CLASSIC_LIGHT", type: "BasemapDefinition", description: "Classic Theme light vector style (free)" },
+            { name: "CLASSIC_DARK", type: "BasemapDefinition", description: "Classic Theme dark vector style (free)" },
+            { name: "MAPTILER_STREETS", type: "BasemapDefinition", description: "MapTiler Streets (requires API key)" },
+            { name: "MAPTILER_SATELLITE", type: "BasemapDefinition", description: "MapTiler Satellite (requires API key)" },
+            { name: "MAPTILER_OUTDOOR", type: "BasemapDefinition", description: "MapTiler Outdoor (requires API key)" },
+            { name: "MAPTILER_BASIC", type: "BasemapDefinition", description: "MapTiler Basic (requires API key)" },
+            { name: "STADIA_ALIDADE_SMOOTH", type: "BasemapDefinition", description: "Stadia Alidade Smooth (requires API key)" },
+            { name: "STADIA_ALIDADE_DARK", type: "BasemapDefinition", description: "Stadia Alidade Dark (requires API key)" },
+            { name: "STADIA_STAMEN_TONER", type: "BasemapDefinition", description: "Stamen Toner artistic style (requires API key)" },
+            { name: "STADIA_STAMEN_WATERCOLOR", type: "BasemapDefinition", description: "Stamen Watercolor artistic style (requires API key)" },
+            { name: "STADIA_STAMEN_TERRAIN", type: "BasemapDefinition", description: "Stamen Terrain outdoor style (requires API key)" }
+          ]
         }
       }
     },
@@ -18326,6 +18362,22 @@ var maps_catalog_default = {
             { name: "showAccuracyCircle", type: "boolean", required: false, description: "Show accuracy circle" },
             { name: "showUserHeading", type: "boolean", required: false, description: "Show user heading" }
           ]
+        },
+        {
+          name: "BasemapSwitcherProps",
+          description: "Props for the basemap switcher control",
+          properties: [
+            { name: "position", type: "ControlPosition", required: false, description: "Position on map (default: 'bottom-right')" },
+            { name: "basemaps", type: "BasemapDefinition[]", required: false, description: "Override the default basemap list (defaults to FREE_BASEMAPS)" },
+            { name: "extraBasemaps", type: "BasemapDefinition[]", required: false, description: "Additional basemaps appended to the default list" },
+            { name: "apiKeys", type: "BasemapApiKeys", required: false, description: "API keys for providers (maptiler, stadia)" },
+            { name: "defaultBasemapId", type: "string", required: false, description: "ID of the initially active basemap" },
+            { name: "activeBasemapId", type: "string", required: false, description: "Controlled active basemap ID" },
+            { name: "onBasemapChange", type: "(basemap: BasemapDefinition) => void", required: false, description: "Callback when basemap changes" },
+            { name: "columns", type: "number", required: false, description: "Grid columns in flyout (default: 3)" },
+            { name: "thumbnailSize", type: "number", required: false, description: "Thumbnail size in pixels (default: 64)" },
+            { name: "class", type: "string", required: false, description: "Additional CSS classes" }
+          ]
         }
       ]
     },
@@ -18672,6 +18724,45 @@ var maps_catalog_default = {
           ]
         }
       ]
+    },
+    basemaps: {
+      description: "Basemap-related types for the basemap switching system",
+      types: [
+        {
+          name: "BasemapProvider",
+          description: "Supported basemap tile providers",
+          type: "'osm' | 'maptiler' | 'stadia' | 'classic-theme' | 'custom'"
+        },
+        {
+          name: "BasemapCategory",
+          description: "Basemap visual categories",
+          type: "'streets' | 'satellite' | 'outdoor' | 'artistic' | 'minimal' | 'dark'"
+        },
+        {
+          name: "BasemapDefinition",
+          description: "Full basemap definition including metadata and style resolution",
+          properties: [
+            { name: "id", type: "string", required: true, description: "Unique basemap identifier" },
+            { name: "name", type: "string", required: true, description: "Display name" },
+            { name: "provider", type: "BasemapProvider", required: true, description: "Tile provider" },
+            { name: "category", type: "BasemapCategory", required: true, description: "Visual category" },
+            { name: "thumbnail", type: "string", required: true, description: "Thumbnail URL (may contain {key} placeholder)" },
+            { name: "style", type: "string | StyleSpecification", required: true, description: "MapLibre style URL or spec (may contain {key} placeholder)" },
+            { name: "requiresApiKey", type: "boolean", required: true, description: "Whether an API key is needed" },
+            { name: "attribution", type: "string", required: false, description: "Custom attribution text" },
+            { name: "label", type: "string", required: false, description: "Short label for UI (defaults to name)" }
+          ]
+        },
+        {
+          name: "BasemapApiKeys",
+          description: "API keys for basemap providers",
+          properties: [
+            { name: "maptiler", type: "string", required: false, description: "MapTiler API key" },
+            { name: "stadia", type: "string", required: false, description: "Stadia Maps API key" },
+            { name: "[provider: string]", type: "string", required: false, description: "Custom provider API key (index signature)" }
+          ]
+        }
+      ]
     }
   },
   components: {
@@ -18701,6 +18792,7 @@ var maps_catalog_default = {
         "Legend",
         "LegendGroup",
         "CoordinateDisplay",
+        "BasemapSwitcher",
         "DeckOverlay"
       ],
       hooks: [
@@ -18708,7 +18800,7 @@ var maps_catalog_default = {
           name: "useMap",
           signature: "() => MapContextValue",
           description: "Hook to access the MapLibre map instance and state from context. Must be used within a Map component.",
-          returns: "{ map: MapLibreMap | null, loaded: boolean, controlOffsets?: ControlOffsets, registerControl?, unregisterControl?, getCustomControlOffset? }"
+          returns: "{ map: MapLibreMap | null, loaded: boolean, styleVersion: number, setMapStyle: (style: string | StyleSpecification) => void, controlOffsets?: ControlOffsets, registerControl?, unregisterControl?, getCustomControlOffset? }"
         },
         {
           name: "useMapInstance",
@@ -18737,6 +18829,8 @@ var maps_catalog_default = {
         value: {
           map: "MapLibreMap | null - The MapLibre map instance",
           loaded: "boolean - Whether the map has loaded",
+          styleVersion: "number - Counter incremented on each style.load event (for basemap switching)",
+          setMapStyle: "(style: string | StyleSpecification) => void - Programmatically change the map style",
           controlOffsets: "Record<string, number> - Pixel offsets for custom controls",
           registerControl: "(id, position, height) => number - Register a custom control",
           unregisterControl: "(id, position) => void - Unregister a custom control",
@@ -18769,13 +18863,14 @@ var maps_catalog_default = {
         "Legend",
         "LegendGroup",
         "CoordinateDisplay",
+        "BasemapSwitcher",
         "DeckOverlay"
       ],
       composables: [
         {
           name: "useMapContext",
-          signature: "() => { map: Writable<Map | null>, loaded: Writable<boolean> }",
-          description: "Get the map context from the parent Map component using Svelte context API"
+          signature: "() => { map: Writable<Map | null>, loaded: Writable<boolean>, styleVersion: number, setMapStyle: (style: string | StyleSpecification) => void }",
+          description: "Get the map context from the parent Map component using Svelte context API. Includes styleVersion counter and setMapStyle for basemap switching."
         },
         {
           name: "useMapTheme",
@@ -18813,7 +18908,7 @@ var maps_catalog_default = {
 </Map>`,
     peerDependency: "maplibre-gl@^4.0.0 || ^5.0.0",
     optionalPeerDependencies: "@deck.gl/core, @deck.gl/layers, @deck.gl/mapbox (for DeckOverlay)",
-    cssImportOrder: "/* In main CSS file - order matters */\n@import '@classic-homes/theme-styles';\n@import 'maplibre-gl/dist/maplibre-gl.css';\n@import '@classic-homes/maps-core/styles/controls.css';\n@import '@classic-homes/maps-core/styles/popup.css';\n\n@tailwind base;\n@tailwind components;\n@tailwind utilities;",
+    cssImportOrder: "/* In main CSS file - order matters */\n@import '@classic-homes/theme-styles';\n@import 'maplibre-gl/dist/maplibre-gl.css';\n@import '@classic-homes/maps-core/styles/controls.css';\n@import '@classic-homes/maps-core/styles/popup.css';\n@import '@classic-homes/maps-core/styles/basemap-switcher.css';\n\n@tailwind base;\n@tailwind components;\n@tailwind utilities;",
     tailwindConfig: "module.exports = {\n  presets: [require('@classic-homes/theme-tailwind-preset')],\n  content: [\n    './src/**/*.{js,ts,jsx,tsx}',\n    './node_modules/@classic-homes/maps-react/dist/**/*.{js,mjs}',\n  ],\n};"
   },
   bestPractices: {
@@ -18858,6 +18953,17 @@ var maps_catalog_default = {
         "Custom layers can use theme colors via the `MapTheme` object from the hook"
       ]
     },
+    basemapSwitching: {
+      title: "Basemap Switching",
+      guidelines: [
+        "Use the BasemapSwitcher control for built-in UI, or call setMapStyle from context for custom UI",
+        "FREE_BASEMAPS provides 3 basemaps that work without API keys (OSM, Classic Light/Dark)",
+        "Use apiKeys prop to enable MapTiler and Stadia Maps basemaps: apiKeys={{ maptiler: 'key', stadia: 'key' }}",
+        "Use extraBasemaps to add custom basemap definitions alongside built-in ones",
+        "Sources and layers are automatically re-initialized after basemap switch via the styleVersion mechanism",
+        "Import basemap-switcher.css: @import '@classic-homes/maps-core/styles/basemap-switcher.css';"
+      ]
+    },
     layerOrdering: {
       title: "Layer Ordering",
       guidelines: [
@@ -19271,6 +19377,7 @@ ${catalog5.quickReference.basicUsage}
 @import 'maplibre-gl/dist/maplibre-gl.css';
 @import '@classic-homes/maps-core/styles/controls.css';
 @import '@classic-homes/maps-core/styles/popup.css';
+@import '@classic-homes/maps-core/styles/basemap-switcher.css';
 
 @tailwind base;
 @tailwind components;