map-gl-offline 0.8.7 → 0.8.9

package/README.md

@@ -25,7 +25,7 @@ TypeScript offline-map library for **MapLibre GL JS** and **Mapbox GL JS**. Down
 npm install map-gl-offline
 ```
 
-Or via CDN as the `mapgloffline` global:
+Or via CDN as the `mapgloffline` global. The UMD build is self-contained — only your map library needs to be on the page:
 
 ```html
 <script src="https://unpkg.com/map-gl-offline/dist/index.umd.js"></script>
@@ -200,6 +200,8 @@ for (const city of cities) {
 
 For composite styles (e.g. Mapbox Standard) that reference sparse tilesets like `indoor-v3` or `landmark-pois-v1`, the tile downloader probes start/middle/end tiles per source and drops any that return majority-404. Disable with `tileOptions: { probeSourcesBeforeDownload: false }`.
 
+Three Mapbox Standard sub-tilesets are sparse-by-design across the planet — `mapbox.indoor-v3`, `mapbox.mapbox-landmark-pois-v1`, `mapbox.procedural-buildings-v1`. Since 0.8.8 these are hard-skipped **before** the probe step so no network request is issued (and no 404s land in devtools). Opt out with `tileOptions: { skipKnownSparseSources: false }` to run them through the probe path instead.
+
 ### Recovering from an incompatible DB
 
 If another app on the same origin has created `offline-map-db` at a newer version, `dbPromise` throws a typed error. Offer a reset UX:
@@ -224,6 +226,7 @@ try {
 ## API at a glance
 
 - **Regions** — `downloadRegion`, `loadRegion`, `addRegion`, `getStoredRegion`, `listStoredRegions`, `listRegions`, `deleteRegion`
+- **Styles** — `downloadStyle`, `downloadMapboxStyle`, `downloadMapLibreStyle`, `downloadStyleWithAutoDetection`, `listStyles`, `loadStyleById`, `getStyleStats`, `deleteStyle`, `cleanupOldStyles`
 - **Analytics** — `getComprehensiveStorageAnalytics`, `getRegionAnalytics`, `getTileStats`, `getFontStats`, `getSpriteStats`, `getGlyphStats`
 - **Cleanup** — `cleanupExpiredRegions`, `performSmartCleanup`, `cleanupOld{Fonts,Sprites,Glyphs}`, `verifyAndRepair{Fonts,Sprites,Glyphs}`, `setupAutoCleanup`, `performCompleteMaintenance`
 - **Import / Export** — `exportRegionAsMBTiles`, `importRegion`, `downloadExportedRegion` (binary SQLite MBTiles, QGIS/tippecanoe-compatible)

package/dist/index.esm.js

@@ -160,6 +160,28 @@ const MAPBOX_API = {
     MODELS_PATH: '/models/v1',
     PROTOCOL: 'mapbox://',
 };
+/**
+ * Mapbox Standard sub-tilesets that are sparse-by-design across the planet.
+ * These only have tiles where the underlying feature (indoor venues, landmark
+ * POIs, 3D procedural buildings) actually exists, and return 404 for nearly
+ * every other coordinate. The tile downloader pre-skips any source whose tile
+ * URL templates reference one of these tileset IDs, so we never issue probe
+ * or download requests for them — eliminating the 404 noise in devtools.
+ *
+ * Matching is done against the tileset segment of the tile URL template
+ * (e.g. `https://api.mapbox.com/v4/mapbox.indoor-v3/{z}/{x}/{y}.vector.pbf`
+ * or `mapbox://mapbox.indoor-v3`).
+ *
+ * The ids below are the ones the live Mapbox Standard style declares — note
+ * that the landmark-POI tileset is `mapbox.mapbox-landmark-pois-v1` (doubled
+ * `mapbox` segment), unlike the other two. The matcher is delimiter-anchored,
+ * so an approximate id silently never matches.
+ */
+const MAPBOX_STANDARD_SPARSE_TILESETS = [
+    'mapbox.indoor-v3',
+    'mapbox.mapbox-landmark-pois-v1',
+    'mapbox.procedural-buildings-v1',
+];
 // Map Providers
 const MAP_PROVIDERS = {
     AUTO: 'auto',
@@ -3262,15 +3284,42 @@ function configureSqlJs(config) {
     sqlJsPromise = null;
 }
 /**
- * Lazily initialise `sql.js`. The underlying module is loaded via dynamic
- * `import()` so it only ships with bundles that actually call MBTiles code.
+ * Resolve the `initSqlJs` factory.
+ *
+ * Bundler builds resolve the npm package via dynamic `import()`, so `sql.js`
+ * only ships with bundles that actually call MBTiles code. The UMD/CDN build
+ * has no module resolver, so the import throws there — fall back to the
+ * `initSqlJs` global that sql.js's own `<script>` build defines.
+ */
+async function resolveInitSqlJs() {
+    let importError;
+    try {
+        const mod = (await import('sql.js'));
+        if (typeof mod?.default === 'function')
+            return mod.default;
+    }
+    catch (error) {
+        // Bare specifier not resolvable (UMD/CDN), or the module threw while
+        // initialising. Either way, try the global before giving up.
+        importError = error;
+    }
+    const globalInit = globalThis.initSqlJs;
+    if (typeof globalInit === 'function')
+        return globalInit;
+    // Preserve the original failure — a module that resolved but threw is a
+    // very different problem from one that couldn't be resolved at all.
+    throw new Error('sql.js could not be loaded. Install `sql.js` when bundling, or load ' +
+        'https://cdn.jsdelivr.net/npm/sql.js/dist/sql-wasm.js before map-gl-offline ' +
+        'when using the UMD build.', importError !== undefined ? { cause: importError } : undefined);
+}
+/**
+ * Lazily initialise `sql.js`.
  */
 async function getSqlJs() {
     if (sqlJsPromise)
         return sqlJsPromise;
     sqlJsPromise = (async () => {
-        const mod = (await import('sql.js'));
-        const initSqlJs = mod.default;
+        const initSqlJs = await resolveInitSqlJs();
         const options = {};
         if (currentConfig.wasmBinary) {
             options.wasmBinary = currentConfig.wasmBinary;
@@ -6124,6 +6173,26 @@ const getExpiredResourceCount = () => cleanupService.getExpiredResourceCount();
 const cleanupExpiredTiles = (styleId) => cleanupService.cleanupExpiredTiles(styleId);
 
 const tileLogger = logger.scope('TileService');
+/**
+ * Match a tile-URL template against the known-sparse Mapbox Standard
+ * sub-tilesets. Catches:
+ *   - `mapbox://<tileset>` — original style source URL.
+ *   - `.../v4/<tileset>.json...` — resolved TileJSON URL produced when the
+ *     library resolves a `mapbox://` source URL into an HTTPS one.
+ *   - `.../v4/<tileset>/{z}/{x}/{y}...` — resolved tile-template URL.
+ */
+function urlReferencesKnownSparseTileset(template) {
+    return MAPBOX_STANDARD_SPARSE_TILESETS.some(tileset => {
+        if (template.includes(`mapbox://${tileset}`))
+            return true;
+        // `/v4/<tileset>` followed by `/` (tile template) or `.` (e.g. `.json`)
+        const idx = template.indexOf(`/${tileset}`);
+        if (idx === -1)
+            return false;
+        const next = template[idx + tileset.length + 1];
+        return next === '/' || next === '.';
+    });
+}
 /**
  * Service for managing offline map tiles
  * Handles downloading, storing, and retrieving map tiles from IndexedDB
@@ -6141,7 +6210,7 @@ class TileService {
      */
     async downloadTiles(region, style, styleId, options = {}) {
         const db = await this.db;
-        const { onProgress, batchSize = 10, maxRetries = 3, skipExisting = true, timeout = 10000, retryDelay = 1000, priorityZoomLevels = [], storageQuotaCheck = true, validateTiles = false, compressTiles = false, bandwidthLimit, probeSourcesBeforeDownload = true, } = options;
+        const { onProgress, batchSize = 10, maxRetries = 3, skipExisting = true, timeout = 10000, retryDelay = 1000, priorityZoomLevels = [], storageQuotaCheck = true, validateTiles = false, compressTiles = false, bandwidthLimit, probeSourcesBeforeDownload = true, skipKnownSparseSources = true, } = options;
         const startTime = Date.now();
         let totalSize = 0;
         let downloadedTiles = 0;
@@ -6245,6 +6314,16 @@ class TileService {
                 tileLogger.debug(`Skipping source ${sourceId}: no tiles array`);
                 continue;
             }
+            // Pre-skip Mapbox Standard sparse sub-tilesets (indoor-v3 etc.) before
+            // issuing any network request. They 404 for nearly every coord in a
+            // typical region; the downstream probe step would catch them, but the
+            // probe itself logs 404s in devtools. Matching here keeps the console
+            // clean.
+            if (skipKnownSparseSources &&
+                tiles.some(template => urlReferencesKnownSparseTileset(template))) {
+                tileLogger.info(`Skipping source "${sourceId}" — references a known sparse Mapbox Standard sub-tileset (no probe/download issued)`);
+                continue;
+            }
             const sourceMinZ = Math.ceil(sourceConfig.minzoom ?? region.minZoom);
             const sourceMaxZ = Math.floor(sourceConfig.maxzoom ?? region.maxZoom);
             let coordsForSource = tileCoords.filter(coord => coord.z >= sourceMinZ && coord.z <= sourceMaxZ);
@@ -7022,7 +7101,8 @@ var tileService$1 = /*#__PURE__*/Object.freeze({
     downloadTiles: downloadTiles,
     getTileAnalytics: getTileAnalytics,
     getTileStats: getTileStats,
-    tileService: tileService
+    tileService: tileService,
+    urlReferencesKnownSparseTileset: urlReferencesKnownSparseTileset
 });
 
 const glyphLogger = logger.scope('GlyphService');
@@ -13977,5 +14057,5 @@ class OfflineManagerControl {
     }
 }
 
-export { AnalyticsService, CONTENT_TYPES, CategorizedError, CleanupService, DB_NAME, DB_VERSION, DOWNLOAD_DEFAULTS, ERROR_MESSAGES, ErrorType, FontService, GLYPH_BLOCK_SIZE, GLYPH_CONFIG, GZIP_MAGIC_BYTES, GlyphService, ImportExportService, LogLevel, MAPBOX_API, MAPBOX_CACHE_TTL, MAPBOX_CLASSIC_STYLES, MAP_PROVIDERS, MAX_GLYPH_CODEPOINT, MaintenanceService, ModelService, OfflineManagerControl, OfflineMapDBVersionError, OfflineMapManager, RESOURCE_TYPES, RegionService, ResourceService, STORAGE_CONFIG, STORE_NAMES, STYLE_CONFIG, SUCCESS_MESSAGES, ScopedLogger, SpriteService, TILE_CONFIG, TileService, URL_SCHEMES, VALIDATION_PATTERNS, applyProxy, categorizeError, cleanupCompressedTiles, cleanupExpiredTiles, cleanupOldFonts, cleanupOldGlyphs, cleanupOldModels, cleanupOldSprites, cleanupOldStyles, cleanupOldTiles, cleanupService, clearAllCaches, configureLogger, configureProxy, configureSqlJs, convertStyleForServiceWorker, countCompressedTiles, createProgressTracker, createTileKey, dbPromise, OfflineMapManager as default, deleteStyleById, deleteStyles, deriveTileExtension, detectCssPrefix, detectStyleProvider, downloadFonts, downloadGlyphs, downloadModels, downloadSprites, downloadStyleWithProvider, downloadStyles, downloadTiles, escapeHtml$1 as escapeHtml, extractAccessToken, extractAllFontNames, extractFontNamesFromTextField, extractTileExtensionFromUrl, fetchResourceWithRetry, fetchWithRetry, fontService, formatBytes, formatDate, generateGlyphUrlsFromStyle, getExpiredResourceCount, getFontAnalytics, getFontStats, getGlyphAnalytics, getGlyphStats, getIcon, getModel, getModelStats, getRegionAnalytics, getSpriteAnalytics, getSpriteStats, getSqlJs, getStyleStats, getTileAnalytics, getTileStats, getUrlHostname, getUserErrorMessage, glyphService, hasImports, hostMatches, i18n, icons, idbFetchHandler, isMapboxHost, isMapboxProtocol, isStyleDownloaded, loadAllStoredRegions, loadGlyphs, loadStyleById, loadStyles, logger, modelKeyBelongsToStyle, modelService, normalizeSpriteProperty, normalizeStyleUrl, optimizeStorage, parseCacheExpiry, parseTileKey, patchStyleForOffline, performCleanup, processBatch, processStyleSources, registerOfflineServiceWorker, resetOfflineMapDB, resolveImports, resolveMapboxUrl, resourceKeyBelongsToStyle, rewriteMapboxCdnTileUrl, safeExecute, sanitizeIndoorExpressions, setupAutoCleanup, spriteService, stopAutoCleanup, t, tileService, unregisterOfflineServiceWorker, validateBounds, validateRegionOptions, validateResource, validateStyleForProvider, validateZoomLevels, verifyAndRepairFonts, verifyAndRepairGlyphs, verifyAndRepairModels, verifyAndRepairSprites };
+export { AnalyticsService, CONTENT_TYPES, CategorizedError, CleanupService, DB_NAME, DB_VERSION, DOWNLOAD_DEFAULTS, ERROR_MESSAGES, ErrorType, FontService, GLYPH_BLOCK_SIZE, GLYPH_CONFIG, GZIP_MAGIC_BYTES, GlyphService, ImportExportService, LogLevel, MAPBOX_API, MAPBOX_CACHE_TTL, MAPBOX_CLASSIC_STYLES, MAPBOX_STANDARD_SPARSE_TILESETS, MAP_PROVIDERS, MAX_GLYPH_CODEPOINT, MaintenanceService, ModelService, OfflineManagerControl, OfflineMapDBVersionError, OfflineMapManager, RESOURCE_TYPES, RegionService, ResourceService, STORAGE_CONFIG, STORE_NAMES, STYLE_CONFIG, SUCCESS_MESSAGES, ScopedLogger, SpriteService, TILE_CONFIG, TileService, URL_SCHEMES, VALIDATION_PATTERNS, applyProxy, categorizeError, cleanupCompressedTiles, cleanupExpiredTiles, cleanupOldFonts, cleanupOldGlyphs, cleanupOldModels, cleanupOldSprites, cleanupOldStyles, cleanupOldTiles, cleanupService, clearAllCaches, configureLogger, configureProxy, configureSqlJs, convertStyleForServiceWorker, countCompressedTiles, createProgressTracker, createTileKey, dbPromise, OfflineMapManager as default, deleteStyleById, deleteStyles, deriveTileExtension, detectCssPrefix, detectStyleProvider, downloadFonts, downloadGlyphs, downloadModels, downloadSprites, downloadStyleWithProvider, downloadStyles, downloadTiles, escapeHtml$1 as escapeHtml, extractAccessToken, extractAllFontNames, extractFontNamesFromTextField, extractTileExtensionFromUrl, fetchResourceWithRetry, fetchWithRetry, fontService, formatBytes, formatDate, generateGlyphUrlsFromStyle, getExpiredResourceCount, getFontAnalytics, getFontStats, getGlyphAnalytics, getGlyphStats, getIcon, getModel, getModelStats, getRegionAnalytics, getSpriteAnalytics, getSpriteStats, getSqlJs, getStyleStats, getTileAnalytics, getTileStats, getUrlHostname, getUserErrorMessage, glyphService, hasImports, hostMatches, i18n, icons, idbFetchHandler, isMapboxHost, isMapboxProtocol, isStyleDownloaded, loadAllStoredRegions, loadGlyphs, loadStyleById, loadStyles, logger, modelKeyBelongsToStyle, modelService, normalizeSpriteProperty, normalizeStyleUrl, optimizeStorage, parseCacheExpiry, parseTileKey, patchStyleForOffline, performCleanup, processBatch, processStyleSources, registerOfflineServiceWorker, resetOfflineMapDB, resolveImports, resolveMapboxUrl, resourceKeyBelongsToStyle, rewriteMapboxCdnTileUrl, safeExecute, sanitizeIndoorExpressions, setupAutoCleanup, spriteService, stopAutoCleanup, t, tileService, unregisterOfflineServiceWorker, urlReferencesKnownSparseTileset, validateBounds, validateRegionOptions, validateResource, validateStyleForProvider, validateZoomLevels, verifyAndRepairFonts, verifyAndRepairGlyphs, verifyAndRepairModels, verifyAndRepairSprites };
 //# sourceMappingURL=index.esm.js.map