@mapmap/maps 0.7.0 → 0.10.0

package/dist/index.js

@@ -104,6 +104,72 @@ function watchForAuthFailures(map, apiKey) {
   }
 }
 
+// src/terrain.ts
+var DEFAULT_TERRAIN_URL = "https://s3.amazonaws.com/elevation-tiles-prod/terrarium/{z}/{x}/{y}.png";
+var DEFAULT_TERRAIN_ATTRIBUTION = '<a href="https://registry.opendata.aws/terrain-tiles/">Terrain data</a> Mapzen, AWS Open Data';
+var TERRAIN_SOURCE_ID = "mapmap-terrain-dem";
+var HILLSHADE_SOURCE_ID = "mapmap-hillshade-dem";
+var HILLSHADE_LAYER_ID = "mapmap-hillshade";
+var MAX_EXAGGERATION = 8;
+function resolveTerrain(input) {
+  if (!input) return null;
+  const o = input === true ? {} : input;
+  const raw = o.exaggeration ?? 1;
+  return {
+    // NaN must not reach MapLibre: it silently flattens the whole terrain.
+    exaggeration: Number.isFinite(raw) ? Math.min(MAX_EXAGGERATION, Math.max(0, raw)) : 1,
+    url: o.url ?? DEFAULT_TERRAIN_URL,
+    encoding: o.encoding ?? "terrarium",
+    maxzoom: o.maxzoom ?? 15,
+    tileSize: o.tileSize ?? 256,
+    attribution: o.attribution ?? DEFAULT_TERRAIN_ATTRIBUTION,
+    hillshade: o.hillshade ?? false
+  };
+}
+function applyTerrain(map, cfg) {
+  const demSpec = {
+    type: "raster-dem",
+    tiles: [cfg.url],
+    encoding: cfg.encoding,
+    tileSize: cfg.tileSize,
+    maxzoom: cfg.maxzoom,
+    attribution: cfg.attribution
+  };
+  if (!map.getSource(TERRAIN_SOURCE_ID)) {
+    map.addSource(TERRAIN_SOURCE_ID, demSpec);
+  }
+  map.setTerrain({ source: TERRAIN_SOURCE_ID, exaggeration: cfg.exaggeration });
+  if (!cfg.hillshade) {
+    if (map.getLayer(HILLSHADE_LAYER_ID)) map.removeLayer(HILLSHADE_LAYER_ID);
+    return;
+  }
+  if (!map.getSource(HILLSHADE_SOURCE_ID)) {
+    map.addSource(HILLSHADE_SOURCE_ID, demSpec);
+  }
+  if (!map.getLayer(HILLSHADE_LAYER_ID)) {
+    const layers = map.getStyle()?.layers ?? [];
+    const firstLineOrSymbol = layers.find(
+      (l) => l.type === "line" || l.type === "symbol"
+    );
+    map.addLayer(
+      {
+        id: HILLSHADE_LAYER_ID,
+        type: "hillshade",
+        source: HILLSHADE_SOURCE_ID,
+        paint: { "hillshade-exaggeration": 0.5 }
+      },
+      firstLineOrSymbol?.id
+    );
+  }
+}
+function removeTerrain(map) {
+  map.setTerrain(null);
+  if (map.getLayer(HILLSHADE_LAYER_ID)) map.removeLayer(HILLSHADE_LAYER_ID);
+  for (const id of [TERRAIN_SOURCE_ID, HILLSHADE_SOURCE_ID]) {
+    if (map.getSource(id)) map.removeSource(id);
+  }
+}
+
 // src/coords.ts
 function toLngLat(point) {
   if (Array.isArray(point)) {
@@ -1887,10 +1953,22 @@ var MapMapMap = class {
     this.effectExplicit = false;
     /** True while an effect re-apply is already queued behind the style. */
     this.effectWaiting = false;
+    /** Resolved terrain config, or null when terrain is off. */
+    this.terrainConfig = null;
     // Lifecycle: `destroy()` must silence anything still queued behind a
     // style load, and the cleanups let it detach those listeners.
     this.destroyed = false;
     this.pendingWaits = /* @__PURE__ */ new Set();
+    // Enforcement notices already logged for THIS map. Per instance, not
+    // per page (diagnostics.ts dedups per page because a duplicated
+    // maplibre-gl is one page-level fault): each map that asks for a
+    // removal is its own licence problem and deserves its own line, but a
+    // theme swap or re-render must never repeat one.
+    this.notices = /* @__PURE__ */ new Set();
+    this.handleStyleLoadForTerrain = () => {
+      if (this.destroyed || !this.terrainConfig) return;
+      applyTerrain(this.map, this.terrainConfig);
+    };
     this.handleStyleLoadForEffects = () => {
       if (this.destroyed) return;
       if (!this.effectExplicit) {
@@ -1908,22 +1986,62 @@ var MapMapMap = class {
     this.navDesign = navDesignFromTheme(theme);
     this.poiDesign = poiDesignFromTheme(theme);
     const style = resolveStyle(options.style, options.territoryTilesUrl);
+    const requestedAttribution = options.mapOptions?.attributionControl;
+    if (requestedAttribution === false) {
+      this.notice(
+        "attribution-removal",
+        "mapOptions.attributionControl: false is ignored - the OpenStreetMap attribution stays on. The credit is a condition of the ODbL that the map data is served under, for MapMap and for you. Pass { compact: true } to collapse it, or { customAttribution } to add your own credit alongside it."
+      );
+    }
+    const attributionControl = {
+      compact: false,
+      ...requestedAttribution === false ? void 0 : requestedAttribution
+    };
     this.map = new maplibregl.Map({
       container: options.container,
       style,
       center: options.center ?? DEFAULT_CENTER,
       zoom: options.zoom ?? DEFAULT_ZOOM,
-      attributionControl: { compact: false },
-      ...options.mapOptions
+      ...options.mapOptions,
+      // Never let the constructor mount the attribution: it would land in
+      // MapLibre's default corner, bottom-RIGHT, which is the mark's
+      // corner. The canonical MapMap layout (Matt, 4 Aug 2026) is
+      // attribution small bottom-LEFT, mark bottom-RIGHT, never stacked —
+      // an SDK map must produce that with zero configuration, because
+      // every embed that got the old both-bottom-right default shipped
+      // the mark sitting on top of the OSM credit, and one demo "fixed"
+      // that by display:none-ing the credit, which is an ODbL breach.
+      attributionControl: false
     });
-    if (options.logo !== false) {
-      const logoOptions = options.logo === true ? {} : options.logo ?? {};
-      this.map.addControl(
-        new LogoControl(logoOptions),
-        logoOptions.position ?? "bottom-right"
+    const attributionPosition = options.attributionPosition ?? "bottom-left";
+    this.map.addControl(
+      new maplibregl.AttributionControl(attributionControl),
+      attributionPosition
+    );
+    if (options.logo === false) {
+      this.notice(
+        "logo-removal",
+        "logo: false is ignored - the MapMap mark stays on the map. Carrying the mark is a condition of the @mapmap/maps licence. Pass logo: { position } to move it to another corner."
       );
     }
+    const logoOptions = typeof options.logo === "object" && options.logo !== null ? options.logo : {};
+    let logoPosition = logoOptions.position ?? "bottom-right";
+    if (logoPosition === attributionPosition) {
+      logoPosition = attributionPosition.endsWith("left") ? "bottom-right" : "bottom-left";
+      this.notice(
+        "logo-collision",
+        `the MapMap mark and the attribution cannot share the ${attributionPosition} corner (the mark would cover the OpenStreetMap credit, which the ODbL requires readable). The mark has moved to ${logoPosition}.`
+      );
+    }
+    this.map.addControl(new LogoControl(logoOptions), logoPosition);
     this.map.on("style.load", this.handleStyleLoadForEffects);
+    this.terrainConfig = resolveTerrain(options.terrain);
+    this.map.on("style.load", this.handleStyleLoadForTerrain);
+    if (this.terrainConfig) {
+      this.whenStyleReady(() => {
+        if (this.terrainConfig) applyTerrain(this.map, this.terrainConfig);
+      });
+    }
     runMapDiagnostics({
       container: options.container,
       map: this.map,
@@ -1931,6 +2049,17 @@ var MapMapMap = class {
       apiKey: this.apiKey
     });
   }
+  /**
+   * Log an enforcement notice at most once for this map. A warning, not
+   * an error and never a throw: `logo: false` and
+   * `attributionControl: false` are published, documented options, and a
+   * hard failure would break a customer's build on a patch upgrade.
+   */
+  notice(notice, message) {
+    if (this.notices.has(notice)) return;
+    this.notices.add(notice);
+    console.warn(`MapMap [${notice}]: ${message}`);
+  }
   /**
    * Run `action` as soon as the style can take layer edits, or now if it
    * already can.
@@ -1962,6 +2091,19 @@ var MapMapMap = class {
     this.pendingWaits.add(cleanup);
     for (const event of events) this.map.on(event, run);
   }
+  /**
+   * Turn terrain on or off after construction. `false` removes the DEM
+   * sources and any hillshade layer this SDK added.
+   */
+  setTerrain(terrain) {
+    if (this.destroyed) return;
+    this.terrainConfig = resolveTerrain(terrain);
+    const cfg = this.terrainConfig;
+    this.whenStyleReady(() => {
+      if (cfg) applyTerrain(this.map, cfg);
+      else removeTerrain(this.map);
+    });
+  }
   /** The current style's `metadata`, if it can be read yet. */
   styleMetadata() {
     try {
@@ -2310,6 +2452,11 @@ var MAX_MARKER_ID_LENGTH = 64;
 var MAX_MARKER_LABEL_LENGTH = 120;
 var MAX_MARKER_TEXT_LENGTH = 3;
 var MARKERS_ID = "mm-user-markers";
+var BAKED_MARKERS_GLYPH_ID = "mm-user-markers-glyph";
+function hasBakedMarkers(map) {
+  const ml = map instanceof MapMapMap ? map.map : map;
+  return ml.getLayer(BAKED_MARKERS_GLYPH_ID) !== void 0;
+}
 var MARKER_IMAGE_MIME = /^data:image\/(png|jpeg|webp|svg\+xml);base64,/;
 function isRecord3(v) {
   return typeof v === "object" && v !== null && !Array.isArray(v);
@@ -2564,11 +2711,12 @@ var MarkersLayer = class {
       type: "FeatureCollection",
       features: this.items.map((item) => this.featureFor(item))
     };
+    const tookOver = this.takeOverBakedLayers();
     const source = this.map.getSource(MARKERS_ID);
-    if (source) {
+    if (source && !tookOver) {
       this.registerImages();
       source.setData(this.data);
-    } else if (this.map.isStyleLoaded()) {
+    } else if (tookOver || this.map.isStyleLoaded()) {
       this.install();
     }
   }
@@ -2671,9 +2819,33 @@ var MarkersLayer = class {
     }
     for (const key of needed) this.registeredImageKeys.add(key);
   }
+  /**
+   * TAKE OVER from a baked style. A style compiled from a theme with an
+   * `extra.markers` block already draws those markers itself, from an
+   * inline GeoJSON source plus two sprite-driven symbol layers — so
+   * installing on top would draw every marker twice, and pointing the SDK's
+   * feature shape at the baked layers would draw nothing sensible (they
+   * read `bodySize`/`anchor`, this layer writes `iconImage`/`iconSize`).
+   *
+   * Take-over rather than no-op, because this layer is a strict superset:
+   * it also renders the custom `data:` image markers and the short-text
+   * numbered pins that a static sprite cannot carry. The baked SOURCE is
+   * kept and its data replaced in place; only the two baked LAYERS go.
+   *
+   * Only ever runs once markers have been set on this layer, so a
+   * `new MarkersLayer(map)` that is never given any leaves a baked style
+   * completely alone. Idempotent; returns whether anything was taken over.
+   */
+  takeOverBakedLayers() {
+    if (this.map.getLayer(BAKED_MARKERS_GLYPH_ID) === void 0) return false;
+    this.map.removeLayer(BAKED_MARKERS_GLYPH_ID);
+    if (this.map.getLayer(MARKERS_ID)) this.map.removeLayer(MARKERS_ID);
+    return true;
+  }
   /** Add-or-update the images, source and layer on the current style. */
   install() {
     if (!this.data) return;
+    this.takeOverBakedLayers();
     this.registerImages();
     const existing = this.map.getSource(MARKERS_ID);
     if (existing) {
@@ -5687,6 +5859,6 @@ function clampVolume(volume) {
   return Math.min(1, Math.max(0, volume));
 }
 
-export { ALERT_CONTRAST_MIN, AdrCheck, CameraAlertChip, DEFAULT_GLYPHS_URL, DEFAULT_TERRITORY_TILES_URL, EFFECTS_METADATA_KEY, FLOW_DEFAULTS, FULL_ATTRIBUTION, FlowRouteEffectLayer, GuidanceBanner, IsochroneLayer, LOGO_SVG, LogoControl, MARKERS_ID, MARKER_DEFAULT_COLOUR, MARKER_GLYPH_IDS, MARKER_GLYPH_VIEWBOX, MARKER_LABEL_TEXT_SIZES, MARKER_PIN_BODY_PATH, MARKER_SIZES, MARKER_SIZES_PX, MAX_MARKER_ID_LENGTH, MAX_MARKER_IMAGE_BYTES, MAX_MARKER_ITEMS, MAX_MARKER_LABEL_LENGTH, MAX_MARKER_TEXT_LENGTH, MAX_PUCK_IMAGE_BYTES, MapMapMap, MarkersLayer, NAV_ALERT_AUDIO_MODES, NAV_ALERT_CHIP_POSITIONS, NAV_ALERT_ICON_SETS, NAV_ALERT_LEAD_DISTANCES, NAV_ALERT_LEAD_DISTANCE_M, NAV_ALERT_MODES, NAV_ALERT_SOUNDS, NAV_ALERT_SOUND_BASE_URL, NAV_ALERT_SOUND_FILES, NAV_CAMERA_DEFAULTS, NAV_CAMERA_KINDS, NavigationCamera, OPENMAPTILES_ATTRIBUTION, OSM_ATTRIBUTION, PALETTE_SLOTS, POI_CATEGORY_COLORS, POI_CATEGORY_IDS, POI_CLASS_CATEGORIES, PlacesLayer, PositionPuck, RIBBON_FLOATS_PER_VERTEX, ROUTE_EFFECTS, RouteLayer, SIGNAL_BLUE, SOURCE_LAYERS, ThemeScheduler, VoiceGuidance, alertChipContent, alertContrastIssues, alertIconSvg, alertIconUrl, alertPresentation, alertSoundUrl, alertSpeedReadoutColor, applyPoiDesign, bannerLanes, bearingBetween, bindFlythroughToScroll, buildAdrCheckBody, buildProbeUrl, buildRouteQuery, buildRouteUrl, buildStyle, builtInPoiColor, cameraKindLabel, cameraKindsShownOnMap, cameraShownOnMap, cameraSpriteName, cameraSymbolLayer, contrastRatio, createMap, createRouteEffect, defaultNavAlertsDesign, defaultNavDesign, defaultPoiDesign, directionArrow, effectsFromStyleMetadata, extractGuidance, flythrough, flythroughPose, formatCoord, formatCoords, haversineDistanceM, isMarkerGlyphId, isNameTextField, laneArrowDirection, languageTextField, lngLatToMercator, markerGlyphPaths, markerImage, markerImageDataKey, markerImageKey, markerText, markerTextImageKey, markersFromTheme, markersFromThemeUrl, navAlertLeadDistanceM, navAlertSoundUrl, navCameraKind, navDesignFromTheme, navDesignFromThemeUrl, parseCssColour, parseHexColor, parseMarkers, parseNavAlertsDesign, parseNavDesign, parseOsrmRoute, parsePoiDesign, placesFromGeoJSON, poiDesignFromTheme, poiDesignFromThemeUrl, poiDesignIsDefault, poiTextColorExpression, prefersReducedMotion, registerPmtilesProtocol, relativeLuminance, renderMarkerImage, resetDiagnostics, resolveTheme, runMapDiagnostics, setMapLanguage, severityProsody, shortestArcDeg, shortestArcDelta, speak, ssmlToText, sunTimes, tessellateRouteRibbon, toLngLat, toPmtilesUrl, truncateChars, uploadProbeBatch };
+export { ALERT_CONTRAST_MIN, AdrCheck, BAKED_MARKERS_GLYPH_ID, CameraAlertChip, DEFAULT_GLYPHS_URL, DEFAULT_TERRAIN_ATTRIBUTION, DEFAULT_TERRAIN_URL, DEFAULT_TERRITORY_TILES_URL, EFFECTS_METADATA_KEY, FLOW_DEFAULTS, FULL_ATTRIBUTION, FlowRouteEffectLayer, GuidanceBanner, IsochroneLayer, LOGO_SVG, LogoControl, MARKERS_ID, MARKER_DEFAULT_COLOUR, MARKER_GLYPH_IDS, MARKER_GLYPH_VIEWBOX, MARKER_LABEL_TEXT_SIZES, MARKER_PIN_BODY_PATH, MARKER_SIZES, MARKER_SIZES_PX, MAX_MARKER_ID_LENGTH, MAX_MARKER_IMAGE_BYTES, MAX_MARKER_ITEMS, MAX_MARKER_LABEL_LENGTH, MAX_MARKER_TEXT_LENGTH, MAX_PUCK_IMAGE_BYTES, MapMapMap, MarkersLayer, NAV_ALERT_AUDIO_MODES, NAV_ALERT_CHIP_POSITIONS, NAV_ALERT_ICON_SETS, NAV_ALERT_LEAD_DISTANCES, NAV_ALERT_LEAD_DISTANCE_M, NAV_ALERT_MODES, NAV_ALERT_SOUNDS, NAV_ALERT_SOUND_BASE_URL, NAV_ALERT_SOUND_FILES, NAV_CAMERA_DEFAULTS, NAV_CAMERA_KINDS, NavigationCamera, OPENMAPTILES_ATTRIBUTION, OSM_ATTRIBUTION, PALETTE_SLOTS, POI_CATEGORY_COLORS, POI_CATEGORY_IDS, POI_CLASS_CATEGORIES, PlacesLayer, PositionPuck, RIBBON_FLOATS_PER_VERTEX, ROUTE_EFFECTS, RouteLayer, SIGNAL_BLUE, SOURCE_LAYERS, ThemeScheduler, VoiceGuidance, alertChipContent, alertContrastIssues, alertIconSvg, alertIconUrl, alertPresentation, alertSoundUrl, alertSpeedReadoutColor, applyPoiDesign, applyTerrain, bannerLanes, bearingBetween, bindFlythroughToScroll, buildAdrCheckBody, buildProbeUrl, buildRouteQuery, buildRouteUrl, buildStyle, builtInPoiColor, cameraKindLabel, cameraKindsShownOnMap, cameraShownOnMap, cameraSpriteName, cameraSymbolLayer, contrastRatio, createMap, createRouteEffect, defaultNavAlertsDesign, defaultNavDesign, defaultPoiDesign, directionArrow, effectsFromStyleMetadata, extractGuidance, flythrough, flythroughPose, formatCoord, formatCoords, hasBakedMarkers, haversineDistanceM, isMarkerGlyphId, isNameTextField, laneArrowDirection, languageTextField, lngLatToMercator, markerGlyphPaths, markerImage, markerImageDataKey, markerImageKey, markerText, markerTextImageKey, markersFromTheme, markersFromThemeUrl, navAlertLeadDistanceM, navAlertSoundUrl, navCameraKind, navDesignFromTheme, navDesignFromThemeUrl, parseCssColour, parseHexColor, parseMarkers, parseNavAlertsDesign, parseNavDesign, parseOsrmRoute, parsePoiDesign, placesFromGeoJSON, poiDesignFromTheme, poiDesignFromThemeUrl, poiDesignIsDefault, poiTextColorExpression, prefersReducedMotion, registerPmtilesProtocol, relativeLuminance, removeTerrain, renderMarkerImage, resetDiagnostics, resolveTerrain, resolveTheme, runMapDiagnostics, setMapLanguage, severityProsody, shortestArcDeg, shortestArcDelta, speak, ssmlToText, sunTimes, tessellateRouteRibbon, toLngLat, toPmtilesUrl, truncateChars, uploadProbeBatch };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map