map-gl-offline 0.8.3 → 0.8.5

package/README.md

@@ -52,13 +52,11 @@ const map = new maplibregl.Map({
 const offlineManager = new OfflineMapManager();
 
 map.on('load', () => {
-  map.addControl(
-    new OfflineManagerControl(offlineManager, {
-      styleUrl: map.getStyle().sprite,
-      mapLib: maplibregl, // enables idb:// protocol
-    }),
-    'top-right',
-  );
+  const control = new OfflineManagerControl(offlineManager, {
+    styleUrl: 'https://api.maptiler.com/maps/streets/style.json?key=YOUR_KEY',
+    mapLib: maplibregl, // enables idb:// protocol in web workers
+  });
+  map.addControl(control, 'top-right');
 });
 ```
 
@@ -103,7 +101,7 @@ map.on('load', () =>
 
 ## Programmatic Usage
 
-`downloadRegion` runs the full pipeline (**style → sprites → glyphs → tiles → metadata**) with per-phase progress. `addRegion` alone only stores metadata — use `downloadRegion` to actually fetch assets.
+`downloadRegion` runs the full pipeline (**style → sprites → glyphs → models → tiles → metadata**) with per-phase progress. `addRegion` alone only stores metadata — use `downloadRegion` to actually fetch assets.
 
 ```typescript
 import { OfflineMapManager } from 'map-gl-offline';

package/dist/index.d.ts

@@ -34,7 +34,7 @@
  * ```typescript
  * const offlineManager = new OfflineMapManager();
  *
- * // downloadRegion runs the full pipeline: style (if missing) → sprites → glyphs → tiles → metadata.
+ * // downloadRegion runs the full pipeline: style (if missing) → sprites → glyphs → models → tiles → metadata.
  * // addRegion on its own only stores metadata; use downloadRegion to actually fetch assets.
  * await offlineManager.downloadRegion(
  *   {
@@ -71,6 +71,6 @@ export * from './types';
 export * from './utils';
 export { OfflineMapManager as default } from './managers/offlineMapManager';
 export { OfflineManagerControl } from './ui/offlineManagerControl';
-export type { MapLibProtocol } from './ui/offlineManagerControl';
+export type { MapLibProtocol, ControlMap } from './ui/offlineManagerControl';
 export { i18n, t } from './ui/translations';
 export type { SupportedLanguage, TranslationKey } from './ui/translations';

package/dist/index.esm.js

@@ -12936,14 +12936,15 @@ class RegionControl {
  * Download Manager for offline map regions.
  *
  * This module handles the complete download workflow for offline map regions,
- * including styles, sprites, glyphs (fonts), and map tiles. It provides
+ * including styles, sprites, glyphs (fonts), 3D models, and map tiles. It provides
  * progress tracking across all download phases.
  *
  * **Download Phases:**
  * 1. `style` - Downloads the map style JSON and processes sources
  * 2. `sprites` - Downloads sprite images and JSON for map icons
  * 3. `glyphs` - Downloads font glyphs for text rendering
- * 4. `tiles` - Downloads map tiles for the specified region bounds
+ * 4. `models` - Downloads 3D model assets (Mapbox Standard trees / turbines)
+ * 5. `tiles` - Downloads map tiles for the specified region bounds
  *
  * **Usage:**
  * The DownloadManager is typically instantiated by the OfflineManagerControl
@@ -13203,7 +13204,7 @@ class ModalManager {
  * - Integrates seamlessly as a MapLibre GL control
  * - Intercepts fetch requests to serve offline resources from IndexedDB
  * - Supports light and dark themes
- * - Shows download progress across all phases (style, sprites, glyphs, tiles)
+ * - Shows download progress across all phases (style, sprites, glyphs, models, tiles)
  * - Optional bounding box visualization for regions
  *
  * @example
@@ -13229,7 +13230,7 @@ const controlLogger = logger.scope('OfflineControl');
 /**
  * MapLibre GL JS control for managing offline map regions.
  *
- * Implements the IControl interface to integrate with MapLibre GL maps.
+ * Implements the IControl interface to integrate with MapLibre GL and Mapbox GL maps.
  * Provides a complete UI for downloading, managing, and loading offline map data.
  *
  * The control automatically intercepts fetch requests to serve offline resources
@@ -13393,10 +13394,13 @@ class OfflineManagerControl {
      * Called when the control is added to a map.
      * Implements the IControl.onAdd interface method.
      *
-     * @param map - The MapLibre GL map instance
+     * @param map - The MapLibre GL or Mapbox GL map instance
      * @returns The control's container element
      */
     onAdd(map) {
+        // Internally the control works against the MapLibre `Map` typings; the
+        // structural `ControlMap` parameter is what lets it satisfy both
+        // libraries' `IControl` so callers need no cast (see issue #39).
         this.map = map;
         // Detect the correct CSS prefix for the map library in use
         const cssPrefix = detectCssPrefix(map.getContainer());