map-gl-offline 0.8.9 → 0.9.0

package/dist/main.d.ts

@@ -1,3 +1,6 @@
 import 'maplibre-gl/dist/maplibre-gl.css';
 import 'mapbox-gl/dist/mapbox-gl.css';
 import 'map-gl-style-switcher/dist/map-gl-style-switcher.css';
+import '@fontsource/barlow/400.css';
+import '@fontsource/barlow/500.css';
+import '@fontsource/barlow/600.css';

package/dist/managers/offlineMapManager/analyticsManagement.d.ts

@@ -1,4 +1,4 @@
-import type { StorageAnalyticsReport } from '../../types';
+import type { StorageAnalyticsReport } from '../../types/index.js';
 import type { OfflineManagerServices } from './base';
 import type { CleanupManagement } from './cleanupManagement';
 export interface AnalyticsManagement {

package/dist/managers/offlineMapManager/base.d.ts

@@ -1,8 +1,8 @@
-import { CleanupService } from '../../services/cleanupService';
-import { RegionService } from '../../services/regionService';
-import { ResourceService } from '../../services/resourceService';
-import { AnalyticsService } from '../../services/analyticsService';
-import { ImportExportService } from '../../services/importExportService';
+import { CleanupService } from '../../services/cleanupService.js';
+import { RegionService } from '../../services/regionService.js';
+import { ResourceService } from '../../services/resourceService.js';
+import { AnalyticsService } from '../../services/analyticsService.js';
+import { ImportExportService } from '../../services/importExportService.js';
 export interface OfflineManagerServices {
     regionService: RegionService;
     cleanupService: CleanupService;

package/dist/managers/offlineMapManager/cleanupManagement.d.ts

@@ -1,8 +1,13 @@
-import type { CleanupResult, RegionAnalytics, RegionCleanupOptions } from '../../types';
+import type { CleanupResult, RegionAnalytics, RegionCleanupOptions } from '../../types/index.js';
 import type { OfflineManagerServices } from './base';
 export interface CleanupManagement {
     getRegionSize(regionId: string, styleId?: string): Promise<number>;
+    /**
+     * Delete regions last updated more than 30 days ago. Age-based by design —
+     * it does not read `region.expiry`; use `forceCleanupExpiredRegions` for that.
+     */
     cleanupExpiredRegions(): Promise<number>;
+    /** Delete regions whose absolute `expiry` timestamp has passed. */
     forceCleanupExpiredRegions(): Promise<number>;
     setupAutoCleanup(options?: RegionCleanupOptions & {
         intervalHours?: number;

package/dist/managers/offlineMapManager/importExportManagement.d.ts

@@ -1,4 +1,4 @@
-import type { ExportResult, ImportExportOptions, ImportResult, MBTilesExportOptions, RegionImportData } from '../../types';
+import type { ExportResult, ImportExportOptions, ImportResult, MBTilesExportOptions, RegionImportData } from '../../types/index.js';
 import type { OfflineManagerServices } from './base';
 /**
  * MBTiles-only import/export surface. Regions are exchanged as real

package/dist/managers/offlineMapManager/maintenanceManagement.d.ts

@@ -1,4 +1,4 @@
-import type { MaintenanceOptions, MaintenanceResults } from '../../types';
+import type { MaintenanceOptions, MaintenanceResults } from '../../types/index.js';
 import type { OfflineManagerServices } from './base';
 import type { CleanupManagement } from './cleanupManagement';
 import type { RegionManagement } from './regionManagement';

package/dist/managers/offlineMapManager/regionManagement.d.ts

@@ -1,10 +1,10 @@
-import type { DownloadRegionOptions, DownloadRegionResult, OfflineRegionOptions, StoredRegion } from '../../types';
+import type { DownloadRegionOptions, DownloadRegionResult, OfflineRegionOptions, StoredRegion } from '../../types/index.js';
 import type { OfflineManagerServices } from './base';
 export interface RegionManagement {
     addRegion(region: OfflineRegionOptions): Promise<void>;
     downloadRegion(region: OfflineRegionOptions, options?: DownloadRegionOptions): Promise<DownloadRegionResult>;
     loadRegion(region: OfflineRegionOptions, options?: DownloadRegionOptions): Promise<DownloadRegionResult>;
-    deleteRegion(regionId: string): Promise<void>;
+    deleteRegion(regionId: string, styleId?: string): Promise<void>;
     listRegions(): Promise<OfflineRegionOptions[]>;
     listStoredRegions(): Promise<StoredRegion[]>;
     getStoredRegion(regionId: string): Promise<StoredRegion | null>;

package/dist/managers/offlineMapManager/resourceManagement.d.ts

@@ -1,4 +1,4 @@
-import type { ResourceService } from '../../services/resourceService';
+import type { ResourceService } from '../../services/resourceService.js';
 import type { OfflineManagerServices } from './base';
 export type ResourceServiceMethod<TMethod extends keyof ResourceService> = ResourceService[TMethod];
 export interface ResourceManagement {

package/dist/managers/offlineMapManager/styleManagement.d.ts

@@ -1,4 +1,4 @@
-import type { EnhancedStyleStats, StyleDownloadOptions, StyleDownloadResult, StyleEntry, StyleProvider } from '../../types';
+import type { EnhancedStyleStats, StyleDownloadOptions, StyleDownloadResult, StyleEntry, StyleProvider } from '../../types/index.js';
 export interface StyleManagement {
     downloadStyle(styleUrl: string, options?: StyleDownloadOptions & {
         provider?: StyleProvider;

package/dist/services/analyticsService.d.ts

@@ -1,5 +1,5 @@
 import { EnhancedGlyphStats } from './glyphService';
-import type { RegionAnalytics, TileStats, StorageAnalyticsReport, EnhancedFontStats, EnhancedSpriteStats } from '../types';
+import type { RegionAnalytics, TileStats, StorageAnalyticsReport, EnhancedFontStats, EnhancedSpriteStats } from '../types/index.js';
 export declare class AnalyticsService {
     getAllTileStats(): Promise<TileStats>;
     getAllFontStats(): Promise<EnhancedFontStats>;

package/dist/services/cleanupService.d.ts

@@ -1,4 +1,4 @@
-import type { StoredRegion, RegionCleanupOptions, CleanupResult, RegionAnalytics } from '../types';
+import type { StoredRegion, RegionCleanupOptions, CleanupResult, RegionAnalytics } from '../types/index.js';
 export declare class CleanupService {
     private db;
     private deleteRegionCallback;
@@ -25,6 +25,7 @@ export declare class CleanupService {
         fonts: number;
         sprites: number;
         glyphs: number;
+        models: number;
         total: number;
     }>;
     /**
@@ -36,7 +37,19 @@ export declare class CleanupService {
         freedSpace: number;
     }>;
     getAllRegions(): Promise<StoredRegion[]>;
+    /**
+     * Bytes of the tiles stored for a region: tiles on its style inside its
+     * bounds, at the zooms the download pipeline fetched for each source. Tiles
+     * are stored per style, so regions that overlap share (and both count)
+     * their common tiles; shared style resources are not included.
+     */
     getRegionSize(regionId: string, styleIdParam?: string): Promise<number>;
+    /**
+     * Bytes stored for a style: its tiles plus the fonts, glyphs, sprites and
+     * models keyed to it. Measured before and after a deletion to report the
+     * space actually freed (a region's own size over-counts tiles it shares).
+     */
+    private getStyleStoredBytes;
     private calculateTotalStorageSize;
     private selectRegionsForDeletion;
     private generateRecommendations;
@@ -57,6 +70,7 @@ export declare const getExpiredResourceCount: () => Promise<{
     fonts: number;
     sprites: number;
     glyphs: number;
+    models: number;
     total: number;
 }>;
 export declare const cleanupExpiredTiles: (styleId?: string) => Promise<{

package/dist/services/fontService.d.ts

@@ -1,4 +1,4 @@
-import type { EnhancedFontStats, FontDownloadOptions, FontDownloadResult } from '../types';
+import type { EnhancedFontStats, FontDownloadOptions, FontDownloadResult } from '../types/index.js';
 export declare class FontService {
     private db;
     downloadFonts(fontUrls: string[], styleName?: string, options?: FontDownloadOptions): Promise<FontDownloadResult>;

package/dist/services/glyphService.d.ts

@@ -1,4 +1,4 @@
-import type { GlyphDownloadOptions, GlyphDownloadResult, GlyphEntry, GlyphRange } from '../types';
+import type { GlyphDownloadOptions, GlyphDownloadResult, GlyphEntry, GlyphRange } from '../types/index.js';
 export interface EnhancedGlyphStats {
     count: number;
     totalSize: number;

package/dist/services/importExportService.d.ts

@@ -1,4 +1,4 @@
-import type { RegionImportData, ImportExportOptions, ImportResult, ExportResult, MBTilesExportOptions } from '../types';
+import type { RegionImportData, ImportExportOptions, ImportResult, ExportResult, MBTilesExportOptions } from '../types/index.js';
 export declare class ImportExportService {
     private db;
     constructor();

package/dist/services/maintenanceService.d.ts

@@ -1,5 +1,5 @@
-import type { StorageAnalyticsReport, MaintenanceOptions, MaintenanceResults, RegionCleanupOptions, CleanupResult } from '../types';
-export type { MaintenanceOptions, MaintenanceResults } from '../types/maintenance';
+import type { StorageAnalyticsReport, MaintenanceOptions, MaintenanceResults, RegionCleanupOptions, CleanupResult } from '../types/index.js';
+export type { MaintenanceOptions, MaintenanceResults } from '../types/maintenance.js';
 export declare class MaintenanceService {
     private performSmartCleanup;
     private listRegions;

package/dist/services/modelService.d.ts

@@ -1,4 +1,6 @@
-import type { ModelEntry, ModelDownloadOptions, ModelDownloadResult, EnhancedModelStats } from '../types';
+import type { ModelEntry, ModelDownloadOptions, ModelDownloadResult, EnhancedModelStats } from '../types/index.js';
+/** Names of the models stored for a style. */
+export declare function storedModelNames(styleId: string): Promise<Set<string>>;
 /** True when the given key belongs to the given styleId's model store prefix. */
 export declare function modelKeyBelongsToStyle(key: string, styleId: string): boolean;
 /**

package/dist/services/regionService.d.ts

@@ -1,4 +1,4 @@
-import type { DownloadRegionOptions, DownloadRegionResult, OfflineRegionOptions, StoredRegion } from '../types/region';
+import type { DownloadRegionOptions, DownloadRegionResult, OfflineRegionOptions, StoredRegion } from '../types/region.js';
 /**
  * True when `key` belongs to the given styleId.
  *
@@ -13,15 +13,8 @@ import type { DownloadRegionOptions, DownloadRegionResult, OfflineRegionOptions,
 export declare function resourceKeyBelongsToStyle(key: string, styleId: string): boolean;
 export declare class RegionService {
     /**
-     * Check if a tile overlaps with any region bounds
-     */
-    private tileOverlapsWithRegion;
-    /**
-     * Check if a tile overlaps with any of the given regions
-     */
-    private tileOverlapsWithAnyRegion;
-    /**
-     * Delete tiles that don't overlap with any remaining regions
+     * Delete tiles no remaining region needs — outside every remaining region's
+     * bounds, or at a zoom none of them downloads for that tile's source.
      */
     private deleteNonOverlappingTiles;
     /**
@@ -31,6 +24,17 @@ export declare class RegionService {
     /**
      * Delete all tiles for a style
      */
+    /**
+     * Delete everything stored for a style except its own entry: tiles, fonts,
+     * glyphs, sprites and models.
+     */
+    /**
+     * Undo what a failed or cancelled download left behind: its partly stored
+     * tiles and its config change. A style this download created, which no other
+     * region uses, goes entirely, and so does a style deleted during the download.
+     */
+    private cleanUpFailedDownload;
+    deleteStyleData(styleId: string): Promise<void>;
     private deleteAllStyleTiles;
     addRegion(region: OfflineRegionOptions): Promise<void>;
     loadRegion(region: OfflineRegionOptions, options?: DownloadRegionOptions): Promise<DownloadRegionResult>;
@@ -44,7 +48,13 @@ export declare class RegionService {
      * Look up the stored style matching a region — by `styleId` first, then `styleUrl`.
      */
     private findStyleEntry;
-    deleteRegion(regionId: string): Promise<void>;
+    /**
+     * Delete a region and the tiles/resources only it needed.
+     * @param styleId - The style holding the region. Region ids are only unique
+     *   within a style, so pass it whenever known; without it the first style
+     *   containing `regionId` is used.
+     */
+    deleteRegion(regionId: string, styleId?: string): Promise<void>;
     listRegions(): Promise<OfflineRegionOptions[]>;
     /**
      * List all stored regions from styles (used for UI and fitBounds)

package/dist/services/resourceService.d.ts

@@ -1,5 +1,5 @@
 import { EnhancedGlyphStats } from './glyphService';
-import type { OfflineRegionOptions, MapboxStyle, TileDownloadOptions, TileDownloadResult, TileStats, SpriteDownloadOptions, SpriteDownloadResult, EnhancedSpriteStats, FontDownloadOptions, FontDownloadResult, EnhancedFontStats, GlyphDownloadOptions, GlyphDownloadResult, ModelDownloadOptions, ModelDownloadResult, EnhancedModelStats } from '../types';
+import type { OfflineRegionOptions, MapboxStyle, TileDownloadOptions, TileDownloadResult, TileStats, SpriteDownloadOptions, SpriteDownloadResult, EnhancedSpriteStats, FontDownloadOptions, FontDownloadResult, EnhancedFontStats, GlyphDownloadOptions, GlyphDownloadResult, ModelDownloadOptions, ModelDownloadResult, EnhancedModelStats } from '../types/index.js';
 export declare class ResourceService {
     downloadTilesWithOptions(region: OfflineRegionOptions, style: MapboxStyle, styleId: string, options?: TileDownloadOptions): Promise<TileDownloadResult>;
     getTileStats(styleId?: string): Promise<TileStats>;
@@ -30,7 +30,7 @@ export declare class ResourceService {
     downloadGlyphsWithOptions(glyphUrl: string, fontstacks: string[], styleName: string, ranges?: string[], options?: GlyphDownloadOptions): Promise<GlyphDownloadResult>;
     getGlyphStats(): Promise<EnhancedGlyphStats>;
     getGlyphAnalytics(): Promise<Record<string, unknown>>;
-    loadGlyphsForStyle(fontstack: string, ranges: string[], styleId?: string): Promise<import("../types").GlyphRange[]>;
+    loadGlyphsForStyle(fontstack: string, ranges: string[], styleId?: string): Promise<import("../types/index.js").GlyphRange[]>;
     cleanupOldGlyphs(styleId?: string, options?: {
         maxAge?: number;
     }): Promise<number>;

package/dist/services/runtimeAssetService.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Cache the code Mapbox GL fetches from api.mapbox.com while rendering: the
+ * Draco and meshopt decoders 3D models need, plus the RTL text and procedural
+ * building modules. The Service Worker serves them back from this cache. They
+ * live in the Cache API rather than IndexedDB because they belong to the
+ * renderer, not to any style or region.
+ *
+ * Failures only log: the rest of a region is still usable without these.
+ *
+ * @returns how many assets are now cached
+ */
+export declare function cacheMapboxRuntimeAssets(): Promise<number>;

package/dist/services/spriteService.d.ts

@@ -1,4 +1,4 @@
-import type { EnhancedSpriteStats, SpriteDownloadOptions, SpriteDownloadResult } from '../types';
+import type { EnhancedSpriteStats, SpriteDownloadOptions, SpriteDownloadResult } from '../types/index.js';
 /**
  * Service for managing map sprite assets
  * Handles downloading, storing, and retrieving sprite images and JSON metadata

package/dist/services/styleService.d.ts

@@ -1,9 +1,22 @@
-import type { StyleProvider, StyleDownloadOptions, StyleDownloadResult, StyleStorageItem, EnhancedStyleStats } from '../types';
+import type { StyleProvider, StyleDownloadOptions, StyleDownloadResult, StyleStorageItem, EnhancedStyleStats } from '../types/index.js';
 export declare function downloadStyles(stylesUrl: string, options?: StyleDownloadOptions): Promise<StyleDownloadResult>;
 export declare function loadStyles(): Promise<StyleStorageItem[]>;
 export declare function loadStyleById(styleId: string): Promise<StyleStorageItem | null>;
+/** Delete every style and everything stored for them. */
 export declare function deleteStyles(): Promise<void>;
+/**
+ * Delete a style, its regions and everything stored for it. The entry goes last,
+ * so a failure part-way leaves the style listed and able to be deleted again.
+ */
 export declare function deleteStyleById(styleId: string): Promise<void>;
+/**
+ * Bytes stored for each style, by style id: its tiles, and its other resources
+ * (glyphs, sprites, models and fonts). Tiles shared by regions count once.
+ */
+export declare function getStyleStorageSizes(): Promise<Record<string, {
+    tiles: number;
+    resources: number;
+}>>;
 /**
  * Get enhanced style statistics
  */

package/dist/services/tileService.d.ts

@@ -1,4 +1,4 @@
-import type { TileDownloadOptions, TileDownloadResult, TileStats, OfflineRegionOptions, MapboxStyle } from '../types';
+import type { TileDownloadOptions, TileDownloadResult, TileStats, OfflineRegionOptions, MapboxStyle } from '../types/index.js';
 /**
  * Match a tile-URL template against the known-sparse Mapbox Standard
  * sub-tilesets. Catches:

package/dist/sheet/collar.d.ts

@@ -0,0 +1,34 @@
+/**
+ * The demo's map collar: latitude and longitude ticks along the map's edge and
+ * a coordinate readout below it, as in the margin of a printed map sheet.
+ * Demo only; nothing here ships in the library.
+ */
+/** The parts of a MapLibre or Mapbox GL map the collar reads. */
+export interface CollarMap {
+    getBounds(): {
+        getWest(): number;
+        getEast(): number;
+        getNorth(): number;
+        getSouth(): number;
+    } | null;
+    getCenter(): {
+        lng: number;
+        lat: number;
+    };
+    getZoom(): number;
+    getBearing(): number;
+    getPitch(): number;
+    project(lngLat: [number, number]): {
+        x: number;
+        y: number;
+    };
+    on(event: string, listener: () => void): unknown;
+}
+/** The smallest round interval that keeps ticks at least `minGap` degrees apart. */
+export declare function tickInterval(minGap: number): number;
+/** Round multiples of `interval` between `min` and `max`. */
+export declare function ticksBetween(min: number, max: number, interval: number): number[];
+export declare function formatLng(lng: number, decimals: number): string;
+export declare function formatLat(lat: number, decimals: number): string;
+/** Keep the collar in step with `map`. */
+export declare function attachCollar(map: CollarMap): void;

package/dist/storage/indexedDbManager.d.ts

@@ -1,5 +1,5 @@
 import { IDBPDatabase } from 'idb';
-import { OfflineMapDB } from '../types';
+import { OfflineMapDB } from '../types/index.js';
 /**
  * Thrown when the on-disk IndexedDB is at a higher schema version than the
  * library was built against — i.e. after a downgrade, or when another app