@tileflow/svelte 0.1.0-alpha.16 → 0.1.0-alpha.18

package/README.md

@@ -26,6 +26,10 @@ Tileflow resolves from the map name, manifest, or explicit style props. Direct
 Tileflow props such as `center`, `zoom`, and `interactive` take priority when
 provided.
 
+Hosted maps automatically preflight a short-lived commercial session grant before eligible
+resources. Setting `analytics={{enabled: false}}` disables the optional beacon only; it does not
+remove hosted authorization or override a user `mapOptions.transformRequest` callback.
+
 ## Headless capture readiness
 
 Use `captureId` to disambiguate repeated named maps:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tileflow/svelte",
-  "version": "0.1.0-alpha.16",
+  "version": "0.1.0-alpha.18",
   "description": "Svelte component for rendering Tileflow maps with MapLibre.",
   "type": "module",
   "sideEffects": false,
@@ -42,7 +42,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@tileflow/core": "0.1.0-alpha.16"
+    "@tileflow/core": ">=0.1.0-alpha.18 <0.1.0-beta.0"
   },
   "peerDependencies": {
     "maplibre-gl": ">=5",

package/src/TileflowMap.svelte

@@ -3,25 +3,21 @@
     type LngLatLike,
     type Map as MapLibreMap,
     type MapOptions as MapLibreMapOptions,
-    type RequestParameters,
-    type RequestTransformFunction,
     type StyleSpecification,
   } from 'maplibre-gl';
   import {createEventDispatcher, onMount, tick} from 'svelte';
   import {
-    createTileflowSessionId,
+    createTileflowSessionController,
     defaultTileflowManifestUrl,
     loadTileflowManifest,
     mergeTileflowAnalytics,
     normalizeTileflowCaptureId,
     normalizeTileflowStaticImageSize,
-    resolveTileflowAnalyticsRequestUrl,
     resolveTileflowManifestMap,
     resolveTileflowMapMode,
     resolveTileflowRuntimeStyle,
     resolveTileflowStaticImageUrl,
     shouldLoadTileflowManifest,
-    startTileflowSession,
     type MapLibreStyle,
     type TileflowAnalytics,
     type TileflowConfig,
@@ -29,6 +25,13 @@
     type TileflowProjectThemes,
     type TileflowRuntimeManifestMap,
   } from '@tileflow/core';
+  import {
+    attachTileflowMapLifecycle,
+    createTileflowMarkerController,
+    createTileflowSessionStarter,
+    createTileflowTransformRequest,
+    type TileflowMapLifecycleAttachment,
+  } from '@tileflow/core/browser';
 
   export let alt = '';
   export let analytics: TileflowAnalytics | undefined = undefined;
@@ -63,7 +66,7 @@
   let imageSize: {height: number; width: number} | null = null;
   let imageResizeObserver: ResizeObserver | null = null;
   let mapInstance: MapLibreMap | null = null;
-  let markerInstances: maplibregl.Marker[] = [];
+  let mapLifecycleAttachment: TileflowMapLifecycleAttachment | null = null;
   let mapResizeObserver: ResizeObserver | null = null;
   let manifestMap: TileflowRuntimeManifestMap | null = null;
   let manifestLoadId = 0;
@@ -72,8 +75,21 @@
   let readinessRunId = 0;
 
   const dispatch = createEventDispatcher<{load: MapLibreMap}>();
-  const sessionId = createTileflowSessionId();
-  const sessionStarts = new Set<string>();
+  const markerController = createTileflowMarkerController<
+    MapLibreMap,
+    TileflowMapMarker,
+    maplibregl.Marker
+  >({
+    attach(markerInstance, targetMap, definition) {
+      markerInstance.setLngLat(definition.coordinates).addTo(targetMap);
+      markerInstance.getElement().title = definition.label ?? definition.id;
+    },
+    create: (definition) =>
+      new maplibregl.Marker({
+        color: definition.color ?? '#C6A15B',
+      }),
+    remove: (markerInstance) => markerInstance.remove(),
+  });
 
   $: resolvedMode = resolveTileflowMapMode({imageUrl, mode, preferLocalDev});
   $: resolvedCaptureId = normalizeTileflowCaptureId(captureId);
@@ -225,11 +241,22 @@
 
   function destroyMap() {
     readinessRunId += 1;
+    const lifecycleAttachment = mapLifecycleAttachment;
+    const currentMap = mapInstance;
+    mapLifecycleAttachment = null;
+    mapInstance = null;
     mapResizeObserver?.disconnect();
     mapResizeObserver = null;
-    clearMarkers();
-    mapInstance?.remove();
-    mapInstance = null;
+
+    try {
+      lifecycleAttachment?.dispose();
+    } finally {
+      try {
+        markerController.dispose();
+      } finally {
+        currentMap?.remove();
+      }
+    }
   }
 
   function recreateMap() {
@@ -241,6 +268,12 @@
     }
 
     const runtime = runtimeStyle;
+    const session = createTileflowSessionController({source: 'svelte'});
+    const sessionStarter = createTileflowSessionStarter({
+      getSessionId: () => session.sessionId,
+      sessionId: session.sessionId,
+      source: 'svelte',
+    });
     const maplibreMap = new maplibregl.Map({
       ...mapOptions,
       attributionControl: mapOptions?.attributionControl ?? {compact: true},
@@ -248,11 +281,14 @@
       container,
       interactive: resolvedInteractive,
       style: runtime.style as StyleSpecification | string,
-      transformRequest: createTransformRequest(
-        () => resolvedAnalytics,
-        sessionId,
-        mapOptions?.transformRequest,
-      ),
+      transformRequest: createTileflowTransformRequest({
+        always: true,
+        asyncAnalyticsTiming: 'request',
+        getAnalytics: () => resolvedAnalytics,
+        sessionController: session,
+        sessionId: session.sessionId,
+        transformRequest: mapOptions?.transformRequest ?? undefined,
+      }),
       zoom: resolvedZoom,
     });
 
@@ -267,47 +303,29 @@
     });
     mapResizeObserver.observe(container);
 
-    maplibreMap.on('load', () => {
-      dispatch('load', maplibreMap);
-      const analyticsForLoad = resolvedAnalytics;
-      const styleId =
-        analyticsForLoad?.styleId ?? (typeof runtime.style === 'string' ? runtime.style : map);
-
-      if (analyticsForLoad?.mapId) {
-        const sessionKey = `${sessionId}:${analyticsForLoad.mapId}:${styleId ?? ''}`;
-
-        if (!sessionStarts.has(sessionKey)) {
-          sessionStarts.add(sessionKey);
-          startTileflowSession(analyticsForLoad, {
-            mapId: analyticsForLoad.mapId,
-            sessionId,
-            source: 'svelte',
-            styleId,
-          });
-        }
-      }
-    });
-    maplibreMap.on('dataloading', () => {
-      readinessRunId += 1;
-      captureState = 'loading';
-    });
-    maplibreMap.on('styledataloading', () => {
-      readinessRunId += 1;
-      captureState = 'loading';
-    });
-    maplibreMap.on('idle', () => {
-      const runId = ++readinessRunId;
-      requestAnimationFrame(() => {
-        requestAnimationFrame(() => {
-          if (runId === readinessRunId && mapInstance === maplibreMap) {
-            captureState = 'idle';
-          }
-        });
-      });
-    });
-    maplibreMap.on('error', () => {
-      readinessRunId += 1;
-      captureState = 'error';
+    mapLifecycleAttachment = attachTileflowMapLifecycle<MapLibreMap, number>({
+      getSession: () => {
+        const analyticsForLoad = resolvedAnalytics;
+        return {
+          analytics: analyticsForLoad,
+          styleId:
+            analyticsForLoad?.styleId ?? (typeof runtime.style === 'string' ? runtime.style : map),
+        };
+      },
+      map: maplibreMap,
+      onLoad: () => dispatch('load', maplibreMap),
+      scheduler: {
+        cancelFrame: (frame) => cancelAnimationFrame(frame),
+        requestFrame: (callback) => requestAnimationFrame(callback),
+      },
+      sessionStarter,
+      setState: (state) => {
+        captureState = state;
+      },
+      subscribe: (targetMap, event, listener) => {
+        const subscription = targetMap.on(event, listener);
+        return () => subscription.unsubscribe();
+      },
     });
 
     syncMarkers();
@@ -321,30 +339,12 @@
   }
 
   function syncMarkers() {
-    clearMarkers();
-
     if (!mapInstance) {
+      markerController.clear();
       return;
     }
 
-    markerInstances = markers.map((marker) => {
-      const markerInstance = new maplibregl.Marker({
-        color: marker.color ?? '#C6A15B',
-      })
-        .setLngLat(marker.coordinates)
-        .addTo(mapInstance!);
-
-      markerInstance.getElement().title = marker.label ?? marker.id;
-      return markerInstance;
-    });
-  }
-
-  function clearMarkers() {
-    for (const marker of markerInstances) {
-      marker.remove();
-    }
-
-    markerInstances = [];
+    markerController.replace(mapInstance, markers);
   }
 
   async function handleImageLoad(event: Event) {
@@ -383,46 +383,6 @@
     captureState = 'error';
   }
 
-  function createTransformRequest(
-    getAnalytics: () => TileflowAnalytics | undefined,
-    session: string,
-    userTransformRequest?: TileflowMapOptions['transformRequest'],
-  ): RequestTransformFunction | undefined {
-    return (url, resourceType) => {
-      const request = userTransformRequest?.(url, resourceType);
-      const analyticsInput = getAnalytics();
-
-      if (isPromiseLike(request)) {
-        return request.then((resolvedRequest) =>
-          applyTileflowAnalyticsRequest(url, resolvedRequest, analyticsInput, session) ??
-          resolvedRequest,
-        );
-      }
-
-      return applyTileflowAnalyticsRequest(url, request, analyticsInput, session);
-    };
-  }
-
-  function applyTileflowAnalyticsRequest(
-    url: string,
-    request: RequestParameters | undefined,
-    analyticsInput: TileflowAnalytics | undefined,
-    session: string,
-  ): RequestParameters | undefined {
-    const requestUrl = request?.url ?? url;
-    const nextUrl = resolveTileflowAnalyticsRequestUrl(requestUrl, analyticsInput, session);
-
-    if (!nextUrl) {
-      return request;
-    }
-
-    return request ? {...request, url: nextUrl} : {url: nextUrl};
-  }
-
-  function isPromiseLike<T>(value: T | Promise<T> | undefined): value is Promise<T> {
-    return Boolean(value && typeof (value as Promise<T>).then === 'function');
-  }
-
   function formatHeight(value: number | string): string {
     return typeof value === 'number' ? `${value}px` : value;
   }