@planet/maps 11.0.0-dev.1740425469803 → 11.0.0-dev.1740442925922

package/internal/render.js

@@ -1,18 +1,23 @@
+import OLMap from 'ol/Map.js';
 import Overlay from 'ol/Overlay.js';
 import View from 'ol/View.js';
 import Control from 'ol/control/Control.js';
 import Interaction from 'ol/interaction/Interaction.js';
 import BaseLayer from 'ol/layer/Base.js';
 import GroupLayer from 'ol/layer/Group.js';
+import Layer from 'ol/layer/Layer.js';
 import Source from 'ol/source/Source.js';
+import Vector from 'ol/source/Vector.js';
 import ReactReconciler from 'react-reconciler';
 import {
   ConcurrentRoot,
   DefaultEventPriority,
+  //@ts-ignore (TODO: remove after https://github.com/DefinitelyTyped/DefinitelyTyped/pull/72046 is released)
   NoEventPriority,
 } from 'react-reconciler/constants.js';
 import {CONTROL, INTERACTION, LAYER, OVERLAY, SOURCE, VIEW} from './config.js';
 import {
+  arrayEquals,
   prepareControlUpdate,
   prepareInteractionUpdate,
   prepareLayerUpdate,
@@ -25,14 +30,23 @@ import {
 const listenerRegex = /^on([A-Z].*)/;
 const listenerColonRegex = /^onChange-/;
 
+/**
+ * @param {string} str A string.
+ */
 function upperFirst(str) {
   return str[0].toUpperCase() + str.slice(1);
 }
 
+/**
+ * @param {string} str A string.
+ */
 function setterName(str) {
   return 'set' + upperFirst(str);
 }
 
+/**
+ * @type {Object<string, boolean>}
+ */
 const knownTypes = {
   [VIEW]: true,
   [OVERLAY]: true,
@@ -43,29 +57,8 @@ const knownTypes = {
 };
 
 /**
- * @param {Array} a1 An array.
- * @param {Array} a2 An array.
- * @return {boolean} All elements in the array are the same;
+ * @type {import('./update.js').Updater}
  */
-function arrayEquals(a1, a2) {
-  if (!a1 || !a2) {
-    return false;
-  }
-  const len1 = a1.length;
-  const len2 = a2.length;
-  if (len1 !== len2) {
-    return false;
-  }
-  for (let i = 0; i < len1; i += 1) {
-    const v1 = a1[i];
-    const v2 = a2[i];
-    if (v1 !== v2) {
-      return false;
-    }
-  }
-  return true;
-}
-
 export function updateInstanceFromProps(instance, type, oldProps, newProps) {
   for (const key in newProps) {
     if (reservedProps[key]) {
@@ -105,31 +98,46 @@ export function updateInstanceFromProps(instance, type, oldProps, newProps) {
       continue;
     }
 
-    if (key === 'features' && typeof instance.addFeatures === 'function') {
-      // TODO: there is likely a smarter way to diff features
-      instance.clear(true);
-      instance.addFeatures(newValue);
-      continue;
+    if (instance instanceof Vector) {
+      if (key === 'features') {
+        // TODO: there is likely a smarter way to diff features
+        instance.clear(true);
+        instance.addFeatures(newValue);
+        continue;
+      }
     }
 
-    if (
-      key === 'interactions' &&
-      typeof instance.addInteraction === 'function'
-    ) {
-      instance.getInteractions().clear();
-      newValue.forEach(interaction => instance.addInteraction(interaction));
-      continue;
-    }
-    if (key === 'controls' && typeof instance.addControl === 'function') {
-      instance.getControls().clear();
-      newValue.forEach(control => instance.addControl(control));
-      continue;
+    if (instance instanceof OLMap) {
+      if (key === 'interactions') {
+        const interactions = /** @type {Array<Interaction>} */ (newValue);
+        instance.getInteractions().clear();
+        interactions.forEach(interaction =>
+          instance.addInteraction(interaction),
+        );
+        continue;
+      }
+      if (key === 'controls') {
+        const controls = /** @type {Array<Control>} */ (newValue);
+        instance.getControls().clear();
+        controls.forEach(control => instance.addControl(control));
+        continue;
+      }
     }
 
     throw new Error(`Cannot update '${key}' property`);
   }
 }
 
+/**
+ * @typedef {Object} InstanceProps
+ * @property {new(options: any) => any} cls A class.
+ * @property {any} [options] The options.
+ */
+
+/**
+ * @param {string} type The string type.
+ * @param {InstanceProps} The instance props.
+ */
 function createInstance(type, {cls: Constructor, ...props}) {
   if (!knownTypes[type]) {
     throw new Error(`Unsupported element type: ${type}`);
@@ -147,6 +155,10 @@ function createTextInstance() {
   throw new Error('Cannot add text to the map');
 }
 
+/**
+ * @param {OLMap} map The map.
+ * @param {any} child The child.
+ */
 function appendChildToContainer(map, child) {
   if (child instanceof View) {
     map.setView(child);
@@ -171,9 +183,13 @@ function appendChildToContainer(map, child) {
   throw new Error(`Cannot add child to the map: ${child}`);
 }
 
+/**
+ * @param {any} parent The parent.
+ * @param {any} child The child.
+ */
 function appendChild(parent, child) {
   if (child instanceof Source) {
-    if (!(parent instanceof BaseLayer)) {
+    if (!(parent instanceof Layer)) {
       throw new Error(`Cannot add source to ${parent}`);
     }
     parent.setSource(child);
@@ -187,6 +203,9 @@ function appendChild(parent, child) {
   throw new Error(`Cannot add ${child} to ${parent}`);
 }
 
+/**
+ * @type {Object<string, import('./update.js').Updater>}
+ */
 const updaters = {
   [VIEW]: prepareViewUpdate,
   [OVERLAY]: prepareOverlayUpdate,
@@ -196,6 +215,12 @@ const updaters = {
   [SOURCE]: prepareSourceUpdate,
 };
 
+/**
+ * @param {any} instance The instance to update.
+ * @param {string} type The string type.
+ * @param {Object<string, any>} oldProps The old props.
+ * @param {Object<string, any>} newProps The new props.
+ */
 function prepareUpdate(instance, type, oldProps, newProps) {
   const updater = updaters[type];
   if (!updater) {
@@ -204,10 +229,17 @@ function prepareUpdate(instance, type, oldProps, newProps) {
   return updater(instance, type, oldProps, newProps);
 }
 
+/**
+ * @type {import('./update.js').Updater}
+ */
 function commitUpdate(instance, type, oldProps, newProps) {
   updateInstanceFromProps(instance, type, oldProps, newProps);
 }
 
+/**
+ * @param {OLMap} map The map.
+ * @param {any} child The object to remove from the map.
+ */
 function removeChildFromContainer(map, child) {
   if (child instanceof View) {
     map.setView(child);
@@ -232,6 +264,10 @@ function removeChildFromContainer(map, child) {
   throw new Error(`Cannot remove child from the map: ${child}`);
 }
 
+/**
+ * @param {any} parent The parent object.
+ * @param {any} child The child object.
+ */
 function removeChild(parent, child) {
   // this happens with group layers
   if (child instanceof BaseLayer && parent.getLayers) {
@@ -241,12 +277,21 @@ function removeChild(parent, child) {
   throw new Error(`TODO: implement removeChild for ${parent} and ${child}`);
 }
 
+/**
+ * @param {OLMap} map The map.
+ */
 function clearContainer(map) {
   map.getLayers().clear();
   // Need to leave the default controls and interactions.
   // TODO: determine when this gets called.
 }
 
+/**
+ * @template {any} T
+ * @param {import("ol/Collection.js").default<T>} collection A collection.
+ * @param {T} child The child to insert.
+ * @param {T} beforeChild The insertion point.
+ */
 function insertInCollection(collection, child, beforeChild) {
   const index = collection.getArray().indexOf(beforeChild);
   if (index < 0) {
@@ -256,6 +301,11 @@ function insertInCollection(collection, child, beforeChild) {
   }
 }
 
+/**
+ * @param {OLMap} map The map.
+ * @param {any} child The child to insert.
+ * @param {any} beforeChild The insertion point.
+ */
 function insertInContainerBefore(map, child, beforeChild) {
   if (child instanceof View) {
     map.setView(child);
@@ -276,6 +326,11 @@ function insertInContainerBefore(map, child, beforeChild) {
   }
 }
 
+/**
+ * @param {any} parent The parent.
+ * @param {any} child The child to insert.
+ * @param {any} beforeChild The insertion point.
+ */
 function insertBefore(parent, child, beforeChild) {
   if (child instanceof BaseLayer && parent instanceof GroupLayer) {
     insertInCollection(parent.getLayers(), child, beforeChild);
@@ -308,6 +363,7 @@ const reconciler = ReactReconciler({
     return null;
   },
 
+  //@ts-ignore
   shouldAttemptEagerTransition() {
     return false;
   },
@@ -330,6 +386,9 @@ const reconciler = ReactReconciler({
     return null;
   },
 
+  /**
+   * @param {number} newPriority The new priority.
+   */
   setCurrentUpdatePriority(newPriority) {
     currentUpdatePriority = newPriority;
   },
@@ -378,8 +437,15 @@ const reconciler = ReactReconciler({
   detachDeletedInstance() {},
 });
 
+/**
+ * @type {Map<any, ReactReconciler.OpaqueRoot>}
+ */
 const roots = new Map();
 
+/**
+ * @param {React.ReactNode} element The element to render.
+ * @param {any} container The container.
+ */
 export function render(element, container) {
   let root = roots.get(container);
   if (!root) {

package/internal/update.js

@@ -1,15 +1,33 @@
-function arrayEquals(a, b) {
-  if (a.length !== b.length) {
+/**
+ * @typedef {function(any, string, Object<string, any>, Object<string, any>): any} Updater
+ */
+
+/**
+ * @param {Array<any>} [a1] An array.
+ * @param {Array<any>} [a2] An array.
+ * @return {boolean} All elements in the array are the same;
+ */
+export function arrayEquals(a1, a2) {
+  if (!a1 || !a2) {
+    return false;
+  }
+  const len = a1.length;
+  if (len !== a2.length) {
     return false;
   }
-  for (let i = 0; i < a.length; i++) {
-    if (a[i] !== b[i]) {
+  for (let i = 0; i < len; i += 1) {
+    const v1 = a1[i];
+    const v2 = a2[i];
+    if (v1 !== v2) {
       return false;
     }
   }
   return true;
 }
 
+/**
+ * @type {Object<string, boolean>}
+ */
 export const reservedProps = {
   children: true,
   cls: true,
@@ -17,10 +35,19 @@ export const reservedProps = {
   ref: true, // TODO: deal with changing ref
 };
 
+/**
+ * @param {import("ol/View.js").default} view The view.
+ * @param {string} type The string type.
+ * @param {Object<string, any>} oldProps The old props.
+ * @param {Object<string, any>} newProps The new props.
+ */
 export function prepareViewUpdate(view, type, oldProps, newProps) {
   if (view.getAnimating()) {
     return null;
   }
+  /**
+   * @type {Object<string, any>}
+   */
   const payload = {};
   let needsUpdate = false;
   for (const key in newProps) {
@@ -71,7 +98,13 @@ export function prepareViewUpdate(view, type, oldProps, newProps) {
   return payload;
 }
 
+/**
+ * @type {Updater}
+ */
 function prepareGenericUpdate(instance, type, oldProps, newProps) {
+  /**
+   * @type {Object<string, any>}
+   */
   const payload = {};
   let needsUpdate = false;
   for (const key in newProps) {

package/layer/Base.js

@@ -15,13 +15,17 @@
  * limitations under the License.
  */
 import OLBase from 'ol/layer/Base.js';
-import propTypes from 'prop-types';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} BaseProps
+ * @property {ConstructorParameters<typeof OLBase>[0]} [options] The layer options.
+ * @property {React.ReactNode} children The layer source.
+ */
+
+/**
+ * @param {BaseProps | Object<string, any>} props The layer props.
+ */
 export default function Base({children, ...props}) {
   return createElement('layer', {cls: OLBase, ...props}, children);
 }
-
-Base.propTypes = {
-  children: propTypes.node,
-};

package/layer/BaseImage.js

@@ -15,13 +15,17 @@
  * limitations under the License.
  */
 import OLBaseImage from 'ol/layer/BaseImage.js';
-import propTypes from 'prop-types';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} BaseImageProps
+ * @property {ConstructorParameters<typeof OLBaseImage>[0]} [options] The layer options.
+ * @property {React.ReactNode} children The layer source.
+ */
+
+/**
+ * @param {BaseImageProps | Object<string, any>} props The layer props.
+ */
 export default function BaseImage({children, ...props}) {
   return createElement('layer', {cls: OLBaseImage, ...props}, children);
 }
-
-BaseImage.propTypes = {
-  children: propTypes.node,
-};

package/layer/BaseTile.js

@@ -15,13 +15,17 @@
  * limitations under the License.
  */
 import OLBaseTile from 'ol/layer/BaseTile.js';
-import propTypes from 'prop-types';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} BaseTileProps
+ * @property {ConstructorParameters<typeof OLBaseTile>[0]} [options] The layer options.
+ * @property {React.ReactNode} children The layer source.
+ */
+
+/**
+ * @param {BaseTileProps | Object<string, any>} props The layer props.
+ */
 export default function BaseTile({children, ...props}) {
   return createElement('layer', {cls: OLBaseTile, ...props}, children);
 }
-
-BaseTile.propTypes = {
-  children: propTypes.node,
-};

package/layer/BaseVector.js

@@ -15,13 +15,17 @@
  * limitations under the License.
  */
 import OLBaseVector from 'ol/layer/BaseVector.js';
-import propTypes from 'prop-types';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} BaseVectorProps
+ * @property {ConstructorParameters<typeof OLBaseVector>[0]} [options] The layer options.
+ * @property {React.ReactNode} children The layer source.
+ */
+
+/**
+ * @param {BaseVectorProps | Object<string, any>} props The layer props.
+ */
 export default function BaseVector({children, ...props}) {
   return createElement('layer', {cls: OLBaseVector, ...props}, children);
 }
-
-BaseVector.propTypes = {
-  children: propTypes.node,
-};

package/layer/Flow.js

@@ -15,13 +15,17 @@
  * limitations under the License.
  */
 import OLFlow from 'ol/layer/Flow.js';
-import propTypes from 'prop-types';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} FlowProps
+ * @property {ConstructorParameters<typeof OLFlow>[0]} [options] The layer options.
+ * @property {React.ReactNode} children The layer source.
+ */
+
+/**
+ * @param {FlowProps | Object<string, any>} props The layer props.
+ */
 export default function Flow({children, ...props}) {
   return createElement('layer', {cls: OLFlow, ...props}, children);
 }
-
-Flow.propTypes = {
-  children: propTypes.node,
-};

package/layer/Graticule.js

@@ -15,13 +15,17 @@
  * limitations under the License.
  */
 import OLGraticule from 'ol/layer/Graticule.js';
-import propTypes from 'prop-types';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} GraticuleProps
+ * @property {ConstructorParameters<typeof OLGraticule>[0]} [options] The layer options.
+ * @property {React.ReactNode} children The layer source.
+ */
+
+/**
+ * @param {GraticuleProps | Object<string, any>} props The layer props.
+ */
 export default function Graticule({children, ...props}) {
   return createElement('layer', {cls: OLGraticule, ...props}, children);
 }
-
-Graticule.propTypes = {
-  children: propTypes.node,
-};

package/layer/Group.js

@@ -15,13 +15,17 @@
  * limitations under the License.
  */
 import OLGroup from 'ol/layer/Group.js';
-import propTypes from 'prop-types';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} GroupProps
+ * @property {ConstructorParameters<typeof OLGroup>[0]} [options] The layer options.
+ * @property {React.ReactNode} children The layer source.
+ */
+
+/**
+ * @param {GroupProps | Object<string, any>} props The layer props.
+ */
 export default function Group({children, ...props}) {
   return createElement('layer', {cls: OLGroup, ...props}, children);
 }
-
-Group.propTypes = {
-  children: propTypes.node,
-};

package/layer/Heatmap.js

@@ -15,13 +15,17 @@
  * limitations under the License.
  */
 import OLHeatmap from 'ol/layer/Heatmap.js';
-import propTypes from 'prop-types';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} HeatmapProps
+ * @property {ConstructorParameters<typeof OLHeatmap>[0]} [options] The layer options.
+ * @property {React.ReactNode} children The layer source.
+ */
+
+/**
+ * @param {HeatmapProps | Object<string, any>} props The layer props.
+ */
 export default function Heatmap({children, ...props}) {
   return createElement('layer', {cls: OLHeatmap, ...props}, children);
 }
-
-Heatmap.propTypes = {
-  children: propTypes.node,
-};

package/layer/Image.js

@@ -15,13 +15,17 @@
  * limitations under the License.
  */
 import OLImage from 'ol/layer/Image.js';
-import propTypes from 'prop-types';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} ImageProps
+ * @property {ConstructorParameters<typeof OLImage>[0]} [options] The layer options.
+ * @property {React.ReactNode} children The layer source.
+ */
+
+/**
+ * @param {ImageProps | Object<string, any>} props The layer props.
+ */
 export default function Image({children, ...props}) {
   return createElement('layer', {cls: OLImage, ...props}, children);
 }
-
-Image.propTypes = {
-  children: propTypes.node,
-};

package/layer/Layer.js

@@ -15,13 +15,17 @@
  * limitations under the License.
  */
 import OLLayer from 'ol/layer/Layer.js';
-import propTypes from 'prop-types';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} LayerProps
+ * @property {ConstructorParameters<typeof OLLayer>[0]} [options] The layer options.
+ * @property {React.ReactNode} children The layer source.
+ */
+
+/**
+ * @param {LayerProps | Object<string, any>} props The layer props.
+ */
 export default function Layer({children, ...props}) {
   return createElement('layer', {cls: OLLayer, ...props}, children);
 }
-
-Layer.propTypes = {
-  children: propTypes.node,
-};

package/layer/MapboxVector.js

@@ -15,13 +15,16 @@
  * limitations under the License.
  */
 import {MapboxVectorLayer as OLMBVectorLayer} from 'ol-mapbox-style';
-import propTypes from 'prop-types';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} MapboxVectorProps
+ * @property {React.ReactNode} children The layer source.
+ */
+
+/**
+ * @param {MapboxVectorProps | Object<string, any>} props The layer props.
+ */
 export default function MapboxVector({children, ...props}) {
   return createElement('layer', {cls: OLMBVectorLayer, ...props}, children);
 }
-
-MapboxVector.propTypes = {
-  children: propTypes.node,
-};

package/layer/Tile.js

@@ -15,13 +15,17 @@
  * limitations under the License.
  */
 import OLTile from 'ol/layer/Tile.js';
-import propTypes from 'prop-types';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} TileProps
+ * @property {ConstructorParameters<typeof OLTile>[0]} [options] The layer options.
+ * @property {React.ReactNode} children The layer source.
+ */
+
+/**
+ * @param {TileProps | Object<string, any>} props The layer props.
+ */
 export default function Tile({children, ...props}) {
   return createElement('layer', {cls: OLTile, ...props}, children);
 }
-
-Tile.propTypes = {
-  children: propTypes.node,
-};

package/layer/Vector.js

@@ -15,13 +15,17 @@
  * limitations under the License.
  */
 import OLVector from 'ol/layer/Vector.js';
-import propTypes from 'prop-types';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} VectorProps
+ * @property {ConstructorParameters<typeof OLVector>[0]} [options] The layer options.
+ * @property {React.ReactNode} children The layer source.
+ */
+
+/**
+ * @param {VectorProps | Object<string, any>} props The layer props.
+ */
 export default function Vector({children, ...props}) {
   return createElement('layer', {cls: OLVector, ...props}, children);
 }
-
-Vector.propTypes = {
-  children: propTypes.node,
-};