@mapvx/web-kit 1.2.0-develop.11 → 1.2.0-develop.13

package/dist/sw/mvx-tiles-sw.js

@@ -51,7 +51,7 @@ const TILE_PREFETCH = {
 
 function delay(ms) {
   return new Promise((resolve) => {
-    self.setTimeout(resolve, ms)
+    globalThis.setTimeout(resolve, ms)
   })
 }
 
@@ -177,6 +177,72 @@ async function prefetchUrlsInBatches(cache, urls, signal) {
   }
 }
 
+/** Fetches the tiles around `center` at `initialZoom`. Returns the budget left after phase 1. */
+async function prefetchInitialZoomTiles(
+  cache,
+  center,
+  initialZoom,
+  trimmedKey,
+  vectorTilesBase,
+  budget,
+  signal,
+) {
+  const phaseOne = tilesAroundCenter(center, initialZoom, TILE_PREFETCH.initialRadiusTiles)
+  const urlsPhaseOne = phaseOne
+    .slice(0, budget)
+    .map(({ z, x, y }) => buildVectorTileUrl(vectorTilesBase, z, x, y, trimmedKey))
+
+  console.log('[MVX-SW] Tile prefetch phase 1 (initial zoom only)', {
+    initialZoom,
+    tiles: urlsPhaseOne.length,
+  })
+  await prefetchUrlsInBatches(cache, urlsPhaseOne, signal)
+  return budget - urlsPhaseOne.length
+}
+
+/** Progressively widens the prefetch to every other zoom level, closest to `initialZoom` first. */
+async function prefetchRemainingZoomLevels(
+  cache,
+  center,
+  initialZoom,
+  minZoom,
+  maxZoom,
+  trimmedKey,
+  vectorTilesBase,
+  budget,
+  signal,
+) {
+  const otherZoomLevels = []
+  for (let z = minZoom; z <= maxZoom; z++) {
+    if (z !== initialZoom) {
+      otherZoomLevels.push(z)
+    }
+  }
+  otherZoomLevels.sort((a, b) => Math.abs(a - initialZoom) - Math.abs(b - initialZoom))
+
+  for (const zoom of otherZoomLevels) {
+    if (signal.aborted || budget <= 0) {
+      break
+    }
+    await delay(TILE_PREFETCH.zoomLevelGapMs)
+    if (signal.aborted) {
+      break
+    }
+
+    const ring = tilesAroundCenter(center, zoom, TILE_PREFETCH.progressiveRadiusTiles)
+    const urls = ring
+      .slice(0, budget)
+      .map(({ z: zz, x, y }) => buildVectorTileUrl(vectorTilesBase, zz, x, y, trimmedKey))
+    budget -= urls.length
+
+    console.log('[MVX-SW] Tile prefetch background zoom', {
+      zoom,
+      tiles: urls.length,
+    })
+    await prefetchUrlsInBatches(cache, urls, signal)
+  }
+}
+
 async function progressivePrefetchTiles(apiKey, placeId, tilesBaseUrl) {
   const trimmedKey = typeof apiKey === 'string' ? apiKey.trim() : ''
   if (trimmedKey === '') {
@@ -221,54 +287,32 @@ async function progressivePrefetchTiles(apiKey, placeId, tilesBaseUrl) {
     const maxZoom = Math.ceil(configuration.limitZoomIn ?? initialZoom + 2)
 
     const cache = await caches.open(CACHE_TILES)
-    let budget = TILE_PREFETCH.maxTilesPerRun
-
-    const phaseOne = tilesAroundCenter(center, initialZoom, TILE_PREFETCH.initialRadiusTiles)
-    const urlsPhaseOne = phaseOne
-      .slice(0, budget)
-      .map(({ z, x, y }) => buildVectorTileUrl(vectorTilesBase, z, x, y, trimmedKey))
-    budget -= urlsPhaseOne.length
-
-    console.log('[MVX-SW] Tile prefetch phase 1 (initial zoom only)', {
+    const budgetAfterPhaseOne = await prefetchInitialZoomTiles(
+      cache,
+      center,
       initialZoom,
-      tiles: urlsPhaseOne.length,
-    })
-    await prefetchUrlsInBatches(cache, urlsPhaseOne, signal)
+      trimmedKey,
+      vectorTilesBase,
+      TILE_PREFETCH.maxTilesPerRun,
+      signal,
+    )
 
-    if (signal.aborted || budget <= 0) {
+    if (signal.aborted || budgetAfterPhaseOne <= 0) {
       console.log('[MVX-SW] Tile prefetch stopped after phase 1')
       return
     }
 
-    const otherZoomLevels = []
-    for (let z = minZoom; z <= maxZoom; z++) {
-      if (z !== initialZoom) {
-        otherZoomLevels.push(z)
-      }
-    }
-    otherZoomLevels.sort((a, b) => Math.abs(a - initialZoom) - Math.abs(b - initialZoom))
-
-    for (const zoom of otherZoomLevels) {
-      if (signal.aborted || budget <= 0) {
-        break
-      }
-      await delay(TILE_PREFETCH.zoomLevelGapMs)
-      if (signal.aborted) {
-        break
-      }
-
-      const ring = tilesAroundCenter(center, zoom, TILE_PREFETCH.progressiveRadiusTiles)
-      const urls = ring
-        .slice(0, budget)
-        .map(({ z: zz, x, y }) => buildVectorTileUrl(vectorTilesBase, zz, x, y, trimmedKey))
-      budget -= urls.length
-
-      console.log('[MVX-SW] Tile prefetch background zoom', {
-        zoom,
-        tiles: urls.length,
-      })
-      await prefetchUrlsInBatches(cache, urls, signal)
-    }
+    await prefetchRemainingZoomLevels(
+      cache,
+      center,
+      initialZoom,
+      minZoom,
+      maxZoom,
+      trimmedKey,
+      vectorTilesBase,
+      budgetAfterPhaseOne,
+      signal,
+    )
 
     console.log('[MVX-SW] Progressive tile prefetch finished')
   } catch (err) {
@@ -300,12 +344,12 @@ async function resetAndUnregister() {
     console.warn('[MVX-SW] resetAndUnregister: clear caches failed', err)
   }
   try {
-    await self.registration.unregister()
+    await globalThis.registration.unregister()
   } catch (err) {
     console.warn('[MVX-SW] resetAndUnregister: unregister failed', err)
   }
   try {
-    const clients = await self.clients.matchAll({ type: 'window' })
+    const clients = await globalThis.clients.matchAll({ type: 'window' })
     for (const client of clients) {
       try {
         client.postMessage({ type: 'SW_RESET_DONE' })
@@ -319,7 +363,7 @@ async function resetAndUnregister() {
 }
 
 function notifyClients(message) {
-  self.clients
+  globalThis.clients
     .matchAll({ includeUncontrolled: true })
     .then((clients) => {
       clients.forEach((client) => {
@@ -343,7 +387,7 @@ const ALLOWED_HOSTS = [
 ]
 const isAllowedHost = (hostname) => ALLOWED_HOSTS.some((host) => hostname.endsWith(host))
 
-self.skipWaiting()
+globalThis.skipWaiting()
 workbox.core.clientsClaim()
 workbox.core.setCacheNameDetails({ prefix: 'mvx' })
 workbox.precaching.cleanupOutdatedCaches()
@@ -504,7 +548,7 @@ registerRoute(
   }),
 )
 
-self.addEventListener('activate', (event) => {
+globalThis.addEventListener('activate', (event) => {
   event.waitUntil(
     (async () => {
       try {
@@ -530,7 +574,11 @@ self.addEventListener('activate', (event) => {
   )
 })
 
-self.addEventListener('message', (event) => {
+globalThis.addEventListener('message', (event) => {
+  // A controlled client can only ever be same-origin with its service worker, but Workbox's own
+  // message listeners don't check this, and neither did this file until now -- check it anyway,
+  // defense in depth against whatever reaches this handler.
+  if (event.origin !== globalThis.location.origin) return
   if (!isValidMessage(event.data)) return
 
   switch (event.data.type) {

package/dist/types/index.d.ts

@@ -298,8 +298,8 @@ declare const FLOOR_SELECTOR_POSITIONS: readonly ["top-left", "top-center", "top
  * Controller for managing floor-related operations.
  */
 declare class FloorController implements ReactiveController {
-    private host;
-    private contextManager;
+    private readonly host;
+    private readonly contextManager;
     constructor(host: ReactiveControllerHost, contextManager: ContextManager);
     hostConnected(): void;
     hostDisconnected(): void;
@@ -417,7 +417,7 @@ declare class FloorSelectorSizeController implements ReactiveController {
 }
 
 export declare class MapViewWithModal extends LitElement {
-    static styles: CSSResult[];
+    static readonly styles: CSSResult[];
     apiKey: string;
     parentPlaceId: string;
     locale: string;
@@ -527,8 +527,8 @@ export declare class MapViewWithModal extends LitElement {
     firstUpdated(): void;
     /** Same shape as the reference's own `baseParams()`: no route, so no destination/origin fields. */
     private baseParams;
-    private _mapReadyHandler;
-    private _cameraInitializedHandler;
+    private readonly _mapReadyHandler;
+    private readonly _cameraInitializedHandler;
     /**
      * The floor id this handler last reported `floor_change` analytics for — this element's own
      * dedupe, independent of `FloorController.setFloor()`'s return value (review round 1, finding 1).
@@ -552,7 +552,7 @@ export declare class MapViewWithModal extends LitElement {
      * side rather than through the controller (see Task 9's identical wiring and its own doc comment).
      * Safe to call for either source: idempotent on an already-applied floor.
      */
-    private _floorChangeHandler;
+    private readonly _floorChangeHandler;
     updated(changedProperties: PropertyValues): void;
     /** The `placeId` last passed to {@link PlaceController.setOriginAndDestination}, or `undefined`. */
     private _placeIdRequestedFor;
@@ -757,8 +757,8 @@ declare interface PlaceContextType {
  * Controller for managing place-related operations.
  */
 declare class PlaceController implements ReactiveController {
-    private host;
-    private contextManager;
+    private readonly host;
+    private readonly contextManager;
     private connected;
     /**
      * Request counter, the reference's `placesRequest`. Every pair load bumps it and keeps the value it
@@ -1110,7 +1110,7 @@ declare class RouteController implements ReactiveController {
 export declare type RoutePanelVariant = 'full' | 'compact';
 
 export declare class RouteViewTotems extends LitElement {
-    static styles: CSSResult[];
+    static readonly styles: CSSResult[];
     apiKey: string;
     parentPlaceId: string;
     /**
@@ -1348,16 +1348,16 @@ export declare class RouteViewTotems extends LitElement {
     private _customMap;
     firstUpdated(): void;
     private sendEvent;
-    private _mapReadyHandler;
-    private _cameraInitializedHandler;
+    private readonly _mapReadyHandler;
+    private readonly _cameraInitializedHandler;
     willUpdate(changedProperties: PropertyValues): void;
     updated(changedProperties: PropertyValues): void;
     render(): TemplateResult<1>;
-    private _floorChangeHandler;
-    private _accessibilityChangeHandler;
-    private _repeatRouteHandler;
-    private _generateRouteHandler;
-    private _backHandler;
+    private readonly _floorChangeHandler;
+    private readonly _accessibilityChangeHandler;
+    private readonly _repeatRouteHandler;
+    private readonly _generateRouteHandler;
+    private readonly _backHandler;
     /**
      * Turns `<custom-map>`'s `startRouteAnimation`/`routeAnimationFinished` events, and
      * `<route-options>`'s `repeatRoute` event, into the matching `RouteController` call. This is the
@@ -1367,9 +1367,9 @@ export declare class RouteViewTotems extends LitElement {
      * `route-view-totems.test.ts`'s "route animation wiring" suite for the regression test proving a
      * natural finish does not trigger a restart.
      */
-    private _startRouteAnimationHandler;
-    private _routeAnimationFinishedHandler;
-    private _dismissRouteErrorHandler;
+    private readonly _startRouteAnimationHandler;
+    private readonly _routeAnimationFinishedHandler;
+    private readonly _dismissRouteErrorHandler;
     /**
      * Updates the component's origin/destination/floor/route-type without requiring a "back" event.
      * Delegates to the inner `<custom-map>`'s own `updateComponent()` (see this class's doc comment for
@@ -1662,13 +1662,6 @@ export declare const WEB_CACHE_CONFIG: CacheConfig;
 export { }
 
 
-declare global {
-    interface HTMLElementTagNameMap {
-        'route-view-totems': RouteViewTotems;
-    }
-}
-
-
 declare global {
     interface HTMLElementTagNameMap {
         'map-view-with-modal': MapViewWithModal;
@@ -1712,54 +1705,59 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'compact-floor-selector': CompactFloorSelector;
+        'route-view-totems': RouteViewTotems;
     }
 }
 
 
 declare global {
     interface HTMLElementTagNameMap {
-        'floor-selector': FloorSelector;
+        'compact-floor-selector': CompactFloorSelector;
     }
 }
 
 
 declare global {
-    interface HTMLElementTagNameMap {
-        'route-options': RouteOptions;
+    var dataLayer: unknown[];
+    var gtag: (...args: unknown[]) => void;
+}
+
+
+declare global {
+    interface HTMLElementEventMap {
+        /**
+         * The loading state changed, with the phase that caused it. One event per transition, and
+         * `detail.loading === false` is the end of the load — the same moment the built-in indicator
+         * goes down.
+         */
+        mvxLoadingChange: CustomEvent<MvxLoadingChangeDetail>;
     }
 }
 
 
 declare global {
     interface HTMLElementTagNameMap {
-        'qr-modal': QRModal;
+        'map-loading-overlay': MapLoadingOverlay;
     }
 }
 
 
 declare global {
-    interface Window {
-        dataLayer: unknown[];
-        gtag: (...args: unknown[]) => void;
+    interface HTMLElementTagNameMap {
+        'floor-selector': FloorSelector;
     }
 }
 
 
 declare global {
-    interface HTMLElementEventMap {
-        /**
-         * The loading state changed, with the phase that caused it. One event per transition, and
-         * `detail.loading === false` is the end of the load — the same moment the built-in indicator
-         * goes down.
-         */
-        mvxLoadingChange: CustomEvent<MvxLoadingChangeDetail>;
+    interface HTMLElementTagNameMap {
+        'route-options': RouteOptions;
     }
 }
 
 
 declare global {
     interface HTMLElementTagNameMap {
-        'map-loading-overlay': MapLoadingOverlay;
+        'qr-modal': QRModal;
     }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mapvx/web-kit",
   "description": "A web component library for building interactive maps.",
-  "version": "1.2.0-develop.11",
+  "version": "1.2.0-develop.13",
   "license": "UNLICENSED",
   "type": "module",
   "publishConfig": {