@deck.gl/mapbox 8.8.0-beta.1 → 8.8.0-beta.2

package/src/resolve-layers.ts

@@ -0,0 +1,89 @@
+import {_flatten as flatten} from '@deck.gl/core';
+import MapboxLayer from './mapbox-layer';
+
+import type {Deck, LayersList, Layer} from '@deck.gl/core';
+import type {Map} from 'mapbox-gl';
+
+const UNDEFINED_BEFORE_ID = '__UNDEFINED__';
+
+/** Insert Deck layers into the mapbox Map according to the user-defined order */
+export function resolveLayers(
+  map?: Map,
+  deck?: Deck,
+  oldLayers?: LayersList,
+  newLayers?: LayersList
+) {
+  // Wait until map style is loaded
+  // @ts-ignore non-public map property
+  if (!map || !deck || !map.style || !map.style._loaded) {
+    return;
+  }
+
+  const layers = flatten(newLayers, Boolean) as Layer[];
+
+  if (oldLayers !== newLayers) {
+    // Step 1: remove layers that no longer exist
+    const prevLayers = flatten(oldLayers, Boolean) as Layer[];
+    const prevLayerIds = new Set<string>(prevLayers.map(l => l.id));
+
+    for (const layer of layers) {
+      prevLayerIds.delete(layer.id);
+    }
+
+    for (const id of prevLayerIds) {
+      if (map.getLayer(id)) {
+        map.removeLayer(id);
+      }
+    }
+  }
+
+  // Step 2: add missing layers
+  for (const layer of layers) {
+    if (!map.getLayer(layer.id)) {
+      map.addLayer(
+        new MapboxLayer({id: layer.id, deck}),
+        // @ts-expect-error beforeId is not defined in LayerProps
+        layer.props.beforeId
+      );
+    }
+  }
+
+  // Step 3: check the order of layers
+  // If beforeId is defined, the deck layer should always render before the mapbox layer [beforeId]
+  // If beforeId is not defined, the deck layer should appear after all mapbox layers
+  // When two deck layers share the same beforeId, they are rendered in the order that is passed into Deck props.layers
+  // @ts-ignore non-public map property
+  const mapLayers: string[] = map.style._order;
+
+  // Group deck layers by beforeId
+  const layerGroups: Record<string, string[]> = {};
+  for (const layer of layers) {
+    // @ts-expect-error beforeId is not defined in LayerProps
+    let {beforeId} = layer.props;
+    if (!beforeId || !mapLayers.includes(beforeId)) {
+      beforeId = UNDEFINED_BEFORE_ID;
+    }
+    layerGroups[beforeId] = layerGroups[beforeId] || [];
+    layerGroups[beforeId].push(layer.id);
+  }
+
+  for (const beforeId in layerGroups) {
+    const layerGroup = layerGroups[beforeId];
+    let lastLayerIndex =
+      beforeId === UNDEFINED_BEFORE_ID ? mapLayers.length : mapLayers.indexOf(beforeId);
+    let lastLayerId = beforeId === UNDEFINED_BEFORE_ID ? undefined : beforeId;
+    for (let i = layerGroup.length - 1; i >= 0; i--) {
+      const layerId = layerGroup[i];
+      const layerIndex = mapLayers.indexOf(layerId);
+      if (layerIndex !== lastLayerIndex - 1) {
+        map.moveLayer(layerId, lastLayerId);
+        if (layerIndex > lastLayerIndex) {
+          // The last layer's index have changed
+          lastLayerIndex++;
+        }
+      }
+      lastLayerIndex--;
+      lastLayerId = layerId;
+    }
+  }
+}

package/typed/deck-utils.d.ts

@@ -15,5 +15,11 @@ export declare function updateLayer(deck: Deck, layer: MapboxLayer<any>): void;
 export declare function drawLayer(deck: Deck, map: Map, layer: MapboxLayer<any>): void;
 export declare function getViewState(map: Map): MapViewState & {
     repeat: boolean;
+    padding: {
+        left: number;
+        right: number;
+        top: number;
+        bottom: number;
+    };
 };
 //# sourceMappingURL=deck-utils.d.ts.map

package/typed/deck-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deck-utils.d.ts","sourceRoot":"","sources":["../src/deck-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAoD,MAAM,eAAe,CAAC;AACtF,OAAO,KAAK,EAAY,YAAY,EAAQ,MAAM,eAAe,CAAC;AAClE,OAAO,KAAK,WAAW,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,WAAW,CAAC;AASnC,wBAAgB,eAAe,CAAC,EAC9B,GAAG,EACH,EAAE,EACF,IAAI,EACL,EAAE;IACD,GAAG,EAAE,GAAG,GAAG;QAAC,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;KAAC,CAAC;IAClC,EAAE,EAAE,qBAAqB,CAAC;IAC1B,IAAI,CAAC,EAAE,IAAI,CAAC;CACb,GAAG,IAAI,CAgEP;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAGlE;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAGrE;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAErE;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAmB7E;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,YAAY,GAAG;IAAC,MAAM,EAAE,OAAO,CAAA;CAAC,CAYvE"}
+{"version":3,"file":"deck-utils.d.ts","sourceRoot":"","sources":["../src/deck-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAoD,MAAM,eAAe,CAAC;AACtF,OAAO,KAAK,EAAY,YAAY,EAAQ,MAAM,eAAe,CAAC;AAClE,OAAO,KAAK,WAAW,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,WAAW,CAAC;AASnC,wBAAgB,eAAe,CAAC,EAC9B,GAAG,EACH,EAAE,EACF,IAAI,EACL,EAAE;IACD,GAAG,EAAE,GAAG,GAAG;QAAC,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;KAAC,CAAC;IAClC,EAAE,EAAE,qBAAqB,CAAC;IAC1B,IAAI,CAAC,EAAE,IAAI,CAAC;CACb,GAAG,IAAI,CAgEP;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAGlE;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAGrE;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAErE;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAmB7E;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,YAAY,GAAG;IACrD,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH,CAaA"}

package/typed/index.d.ts

@@ -1,3 +1,4 @@
 export { default as MapboxLayer } from './mapbox-layer';
 export { default as MapboxOverlay } from './mapbox-overlay';
+export type { MapboxOverlayProps } from './mapbox-overlay';
 //# sourceMappingURL=index.d.ts.map

package/typed/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,aAAa,EAAC,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,IAAI,WAAW,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAC,OAAO,IAAI,aAAa,EAAC,MAAM,kBAAkB,CAAC;AAE1D,YAAY,EAAC,kBAAkB,EAAC,MAAM,kBAAkB,CAAC"}

package/typed/mapbox-overlay.d.ts

@@ -1,6 +1,7 @@
 import { Deck } from '@deck.gl/core/typed';
 import type { Map, IControl } from 'mapbox-gl';
 import type { DeckProps } from '@deck.gl/core/typed';
+export declare type MapboxOverlayProps = Omit<DeckProps, 'width' | 'height' | 'gl' | 'parent' | 'canvas' | '_customRender' | 'viewState' | 'initialViewState' | 'controller'>;
 /**
  * Implements Mapbox [IControl](https://docs.mapbox.com/mapbox-gl-js/api/markers/#icontrol) interface
  * Renders deck.gl layers over the base map and automatically synchronizes with the map's camera
@@ -10,13 +11,20 @@ export default class MapboxOverlay implements IControl {
     private _deck?;
     private _map?;
     private _container?;
-    constructor(props: DeckProps);
+    private _interleaved;
+    constructor(props: MapboxOverlayProps & {
+        interleaved?: boolean;
+    });
     /** Update (partial) props of the underlying Deck instance. */
-    setProps(props: DeckProps): void;
+    setProps(props: MapboxOverlayProps): void;
     /** Called when the control is added to a map */
     onAdd(map: Map): HTMLDivElement;
+    private _onAddOverlaid;
+    private _onAddInterleaved;
     /** Called when the control is removed from a map */
     onRemove(): void;
+    private _onRemoveOverlaid;
+    private _onRemoveInterleaved;
     getDefaultPosition(): string;
     /** Forwards the Deck.pickObject method */
     pickObject(params: Parameters<Deck['pickObject']>[0]): ReturnType<Deck['pickObject']>;
@@ -26,6 +34,7 @@ export default class MapboxOverlay implements IControl {
     pickObjects(params: Parameters<Deck['pickObjects']>[0]): ReturnType<Deck['pickObjects']>;
     /** Remove from map and releases all resources */
     finalize(): void;
+    private _handleStyleChange;
     private _updateContainerSize;
     private _updateViewState;
     private _handleMouseEvent;

package/typed/mapbox-overlay.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mapbox-overlay.d.ts","sourceRoot":"","sources":["../src/mapbox-overlay.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAS,MAAM,eAAe,CAAC;AAG3C,OAAO,KAAK,EAAC,GAAG,EAAE,QAAQ,EAAgB,MAAM,WAAW,CAAC;AAE5D,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,eAAe,CAAC;AAE7C;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,aAAc,YAAW,QAAQ;IACpD,OAAO,CAAC,MAAM,CAAY;IAC1B,OAAO,CAAC,KAAK,CAAC,CAAO;IACrB,OAAO,CAAC,IAAI,CAAC,CAAM;IACnB,OAAO,CAAC,UAAU,CAAC,CAAiB;gBAExB,KAAK,EAAE,SAAS;IAI5B,8DAA8D;IAC9D,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAYhC,gDAAgD;IAChD,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,cAAc;IA8B/B,oDAAoD;IACpD,QAAQ,IAAI,IAAI;IAkBhB,kBAAkB;IAIlB,0CAA0C;IAC1C,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAKrF,mDAAmD;IACnD,mBAAmB,CACjB,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,GACjD,UAAU,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;IAK1C,2CAA2C;IAC3C,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAKxF,iDAAiD;IACjD,QAAQ;IAMR,OAAO,CAAC,oBAAoB,CAQ1B;IAEF,OAAO,CAAC,gBAAgB,CAQtB;IAEF,OAAO,CAAC,iBAAiB,CA4CvB;CACH"}
+{"version":3,"file":"mapbox-overlay.d.ts","sourceRoot":"","sources":["../src/mapbox-overlay.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAS,MAAM,eAAe,CAAC;AAG3C,OAAO,KAAK,EAAC,GAAG,EAAE,QAAQ,EAAgB,MAAM,WAAW,CAAC;AAE5D,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,eAAe,CAAC;AAI7C,oBAAY,kBAAkB,GAAG,IAAI,CACnC,SAAS,EACP,OAAO,GACP,QAAQ,GACR,IAAI,GACJ,QAAQ,GACR,QAAQ,GACR,eAAe,GACf,WAAW,GACX,kBAAkB,GAClB,YAAY,CACf,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,aAAc,YAAW,QAAQ;IACpD,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,KAAK,CAAC,CAAO;IACrB,OAAO,CAAC,IAAI,CAAC,CAAM;IACnB,OAAO,CAAC,UAAU,CAAC,CAAiB;IACpC,OAAO,CAAC,YAAY,CAAU;gBAG5B,KAAK,EAAE,kBAAkB,GAAG;QAC1B,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB;IAOH,8DAA8D;IAC9D,QAAQ,CAAC,KAAK,EAAE,kBAAkB,GAAG,IAAI;IAYzC,gDAAgD;IAChD,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,cAAc;IAK/B,OAAO,CAAC,cAAc;IA4BtB,OAAO,CAAC,iBAAiB;IAazB,oDAAoD;IACpD,QAAQ,IAAI,IAAI;IAiBhB,OAAO,CAAC,iBAAiB;IASzB,OAAO,CAAC,oBAAoB;IAK5B,kBAAkB;IAIlB,0CAA0C;IAC1C,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAKrF,mDAAmD;IACnD,mBAAmB,CACjB,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,GACjD,UAAU,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;IAK1C,2CAA2C;IAC3C,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAKxF,iDAAiD;IACjD,QAAQ;IAMR,OAAO,CAAC,kBAAkB,CAExB;IAEF,OAAO,CAAC,oBAAoB,CAQ1B;IAEF,OAAO,CAAC,gBAAgB,CAQtB;IAEF,OAAO,CAAC,iBAAiB,CA4CvB;CACH"}

package/typed/resolve-layers.d.ts

@@ -0,0 +1,5 @@
+import type { Deck, LayersList } from '@deck.gl/core/typed';
+import type { Map } from 'mapbox-gl';
+/** Insert Deck layers into the mapbox Map according to the user-defined order */
+export declare function resolveLayers(map?: Map, deck?: Deck, oldLayers?: LayersList, newLayers?: LayersList): void;
+//# sourceMappingURL=resolve-layers.d.ts.map

package/typed/resolve-layers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-layers.d.ts","sourceRoot":"","sources":["../src/resolve-layers.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,IAAI,EAAE,UAAU,EAAQ,MAAM,eAAe,CAAC;AAC3D,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,WAAW,CAAC;AAInC,iFAAiF;AACjF,wBAAgB,aAAa,CAC3B,GAAG,CAAC,EAAE,GAAG,EACT,IAAI,CAAC,EAAE,IAAI,EACX,SAAS,CAAC,EAAE,UAAU,EACtB,SAAS,CAAC,EAAE,UAAU,QA2EvB"}