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

package/Map.js

@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 import OLMap from 'ol/Map.js';
-import propTypes from 'prop-types';
 import {createElement, useCallback, useEffect, useRef} from 'react';
 import {MAP} from './internal/config.js';
 import {render, updateInstanceFromProps} from './internal/render.js';
@@ -24,6 +23,19 @@ const defaultDivStyle = {
   width: '100%',
 };
 
+/**
+ * @typedef {Object} MapProps
+ * @property {ConstructorParameters<typeof OLMap>[0]} [options] Map constructor options.
+ * @property {React.ReactNode} children The map children.
+ * @property {React.Ref<OLMap> | (function(OLMap):void)} [ref] The map ref.
+ * @property {string} [id] The element id.
+ * @property {React.CSSProperties} [style] The element style.
+ * @property {string} [className] The element class name.
+ */
+
+/**
+ * @param {MapProps | Object<string, any>} props Map props.
+ */
 export default function Map({
   id,
   style = defaultDivStyle,
@@ -33,8 +45,8 @@ export default function Map({
   options,
   ...mapProps
 }) {
-  const targetRef = useRef();
-  const mapRef = useRef();
+  const targetRef = useRef(/** @type {HTMLElement?} */ (null));
+  const mapRef = useRef(/** @type {OLMap?} */ (null));
 
   const getMap = useCallback(() => {
     // avoid creating new map when options object is different
@@ -49,7 +61,7 @@ export default function Map({
 
   useEffect(() => {
     const map = getMap();
-    map.setTarget(targetRef.current);
+    map.setTarget(targetRef.current ?? undefined);
   }, [getMap]);
 
   useEffect(() => {
@@ -70,15 +82,3 @@ export default function Map({
 
   return createElement('div', {ref: targetRef, id, style, className});
 }
-
-Map.propTypes = {
-  className: propTypes.string,
-  id: propTypes.string,
-  style: propTypes.object,
-  children: propTypes.node,
-  options: propTypes.object,
-  ref: propTypes.oneOfType([
-    propTypes.func,
-    propTypes.shape({current: propTypes.any}),
-  ]),
-};

package/Overlay.js

@@ -17,6 +17,14 @@ import OLOverlay from 'ol/Overlay.js';
 import {createElement} from 'react';
 import {OVERLAY} from './internal/config.js';
 
+/**
+ * @typedef {Object} OverlayProps
+ * @property {ConstructorParameters<typeof OLOverlay>[0]} options Overlay constructor options.
+ */
+
+/**
+ * @param {OverlayProps | Object<string, any>} props Overlay props.
+ */
 export default function Overlay(props) {
   return createElement(OVERLAY, {cls: OLOverlay, ...props});
 }

package/View.js

@@ -17,6 +17,14 @@ import OLView from 'ol/View.js';
 import {createElement} from 'react';
 import {VIEW} from './internal/config.js';
 
+/**
+ * @typedef {Object} ViewProps
+ * @property {ConstructorParameters<typeof OLView>[0]} options View constructor options.
+ */
+
+/**
+ * @param {ViewProps | Object<string, any>} props View props.
+ */
 export default function View(props) {
   return createElement(VIEW, {cls: OLView, ...props});
 }

package/control/Attribution.js

@@ -17,6 +17,14 @@
 import OLAttribution from 'ol/control/Attribution.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} AttributionProps
+ * @property {ConstructorParameters<typeof OLAttribution>[0]} [options] The control options.
+ */
+
+/**
+ * @param {AttributionProps | Object<string, any>} props The control props.
+ */
 export default function Attribution(props) {
   return createElement('control', {cls: OLAttribution, ...props});
 }

package/control/Control.js

@@ -17,6 +17,14 @@
 import OLControl from 'ol/control/Control.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} ControlProps
+ * @property {ConstructorParameters<typeof OLControl>[0]} [options] The control options.
+ */
+
+/**
+ * @param {ControlProps | Object<string, any>} props The control props.
+ */
 export default function Control(props) {
   return createElement('control', {cls: OLControl, ...props});
 }

package/control/FullScreen.js

@@ -17,6 +17,14 @@
 import OLFullScreen from 'ol/control/FullScreen.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} FullScreenProps
+ * @property {ConstructorParameters<typeof OLFullScreen>[0]} [options] The control options.
+ */
+
+/**
+ * @param {FullScreenProps | Object<string, any>} props The control props.
+ */
 export default function FullScreen(props) {
   return createElement('control', {cls: OLFullScreen, ...props});
 }

package/control/MousePosition.js

@@ -17,6 +17,14 @@
 import OLMousePosition from 'ol/control/MousePosition.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} MousePositionProps
+ * @property {ConstructorParameters<typeof OLMousePosition>[0]} [options] The control options.
+ */
+
+/**
+ * @param {MousePositionProps | Object<string, any>} props The control props.
+ */
 export default function MousePosition(props) {
   return createElement('control', {cls: OLMousePosition, ...props});
 }

package/control/OverviewMap.js

@@ -17,6 +17,14 @@
 import OLOverviewMap from 'ol/control/OverviewMap.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} OverviewMapProps
+ * @property {ConstructorParameters<typeof OLOverviewMap>[0]} [options] The control options.
+ */
+
+/**
+ * @param {OverviewMapProps | Object<string, any>} props The control props.
+ */
 export default function OverviewMap(props) {
   return createElement('control', {cls: OLOverviewMap, ...props});
 }

package/control/Rotate.js

@@ -17,6 +17,14 @@
 import OLRotate from 'ol/control/Rotate.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} RotateProps
+ * @property {ConstructorParameters<typeof OLRotate>[0]} [options] The control options.
+ */
+
+/**
+ * @param {RotateProps | Object<string, any>} props The control props.
+ */
 export default function Rotate(props) {
   return createElement('control', {cls: OLRotate, ...props});
 }

package/control/ScaleLine.js

@@ -17,6 +17,14 @@
 import OLScaleLine from 'ol/control/ScaleLine.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} ScaleLineProps
+ * @property {ConstructorParameters<typeof OLScaleLine>[0]} [options] The control options.
+ */
+
+/**
+ * @param {ScaleLineProps | Object<string, any>} props The control props.
+ */
 export default function ScaleLine(props) {
   return createElement('control', {cls: OLScaleLine, ...props});
 }

package/control/Zoom.js

@@ -17,6 +17,14 @@
 import OLZoom from 'ol/control/Zoom.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} ZoomProps
+ * @property {ConstructorParameters<typeof OLZoom>[0]} [options] The control options.
+ */
+
+/**
+ * @param {ZoomProps | Object<string, any>} props The control props.
+ */
 export default function Zoom(props) {
   return createElement('control', {cls: OLZoom, ...props});
 }

package/control/ZoomSlider.js

@@ -17,6 +17,14 @@
 import OLZoomSlider from 'ol/control/ZoomSlider.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} ZoomSliderProps
+ * @property {ConstructorParameters<typeof OLZoomSlider>[0]} [options] The control options.
+ */
+
+/**
+ * @param {ZoomSliderProps | Object<string, any>} props The control props.
+ */
 export default function ZoomSlider(props) {
   return createElement('control', {cls: OLZoomSlider, ...props});
 }

package/control/ZoomToExtent.js

@@ -17,6 +17,14 @@
 import OLZoomToExtent from 'ol/control/ZoomToExtent.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} ZoomToExtentProps
+ * @property {ConstructorParameters<typeof OLZoomToExtent>[0]} [options] The control options.
+ */
+
+/**
+ * @param {ZoomToExtentProps | Object<string, any>} props The control props.
+ */
 export default function ZoomToExtent(props) {
   return createElement('control', {cls: OLZoomToExtent, ...props});
 }

package/interaction/DblClickDragZoom.js

@@ -17,6 +17,14 @@
 import OLDblClickDragZoom from 'ol/interaction/DblClickDragZoom.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} DblClickDragZoomProps
+ * @property {ConstructorParameters<typeof OLDblClickDragZoom>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {DblClickDragZoomProps | Object<string, any>} props The interaction props.
+ */
 export default function DblClickDragZoom(props) {
   return createElement('interaction', {cls: OLDblClickDragZoom, ...props});
 }

package/interaction/DoubleClickZoom.js

@@ -17,6 +17,14 @@
 import OLDoubleClickZoom from 'ol/interaction/DoubleClickZoom.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} DoubleClickZoomProps
+ * @property {ConstructorParameters<typeof OLDoubleClickZoom>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {DoubleClickZoomProps | Object<string, any>} props The interaction props.
+ */
 export default function DoubleClickZoom(props) {
   return createElement('interaction', {cls: OLDoubleClickZoom, ...props});
 }

package/interaction/DragAndDrop.js

@@ -17,6 +17,14 @@
 import OLDragAndDrop from 'ol/interaction/DragAndDrop.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} DragAndDropProps
+ * @property {ConstructorParameters<typeof OLDragAndDrop>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {DragAndDropProps | Object<string, any>} props The interaction props.
+ */
 export default function DragAndDrop(props) {
   return createElement('interaction', {cls: OLDragAndDrop, ...props});
 }

package/interaction/DragBox.js

@@ -17,6 +17,14 @@
 import OLDragBox from 'ol/interaction/DragBox.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} DragBoxProps
+ * @property {ConstructorParameters<typeof OLDragBox>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {DragBoxProps | Object<string, any>} props The interaction props.
+ */
 export default function DragBox(props) {
   return createElement('interaction', {cls: OLDragBox, ...props});
 }

package/interaction/DragPan.js

@@ -17,6 +17,14 @@
 import OLDragPan from 'ol/interaction/DragPan.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} DragPanProps
+ * @property {ConstructorParameters<typeof OLDragPan>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {DragPanProps | Object<string, any>} props The interaction props.
+ */
 export default function DragPan(props) {
   return createElement('interaction', {cls: OLDragPan, ...props});
 }

package/interaction/DragRotate.js

@@ -17,6 +17,14 @@
 import OLDragRotate from 'ol/interaction/DragRotate.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} DragRotateProps
+ * @property {ConstructorParameters<typeof OLDragRotate>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {DragRotateProps | Object<string, any>} props The interaction props.
+ */
 export default function DragRotate(props) {
   return createElement('interaction', {cls: OLDragRotate, ...props});
 }

package/interaction/DragRotateAndZoom.js

@@ -17,6 +17,14 @@
 import OLDragRotateAndZoom from 'ol/interaction/DragRotateAndZoom.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} DragRotateAndZoomProps
+ * @property {ConstructorParameters<typeof OLDragRotateAndZoom>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {DragRotateAndZoomProps | Object<string, any>} props The interaction props.
+ */
 export default function DragRotateAndZoom(props) {
   return createElement('interaction', {cls: OLDragRotateAndZoom, ...props});
 }

package/interaction/DragZoom.js

@@ -17,6 +17,14 @@
 import OLDragZoom from 'ol/interaction/DragZoom.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} DragZoomProps
+ * @property {ConstructorParameters<typeof OLDragZoom>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {DragZoomProps | Object<string, any>} props The interaction props.
+ */
 export default function DragZoom(props) {
   return createElement('interaction', {cls: OLDragZoom, ...props});
 }

package/interaction/Draw.js

@@ -17,6 +17,14 @@
 import OLDraw from 'ol/interaction/Draw.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} DrawProps
+ * @property {ConstructorParameters<typeof OLDraw>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {DrawProps | Object<string, any>} props The interaction props.
+ */
 export default function Draw(props) {
   return createElement('interaction', {cls: OLDraw, ...props});
 }

package/interaction/Extent.js

@@ -17,6 +17,14 @@
 import OLExtent from 'ol/interaction/Extent.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} ExtentProps
+ * @property {ConstructorParameters<typeof OLExtent>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {ExtentProps | Object<string, any>} props The interaction props.
+ */
 export default function Extent(props) {
   return createElement('interaction', {cls: OLExtent, ...props});
 }

package/interaction/Interaction.js

@@ -17,6 +17,14 @@
 import OLInteraction from 'ol/interaction/Interaction.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} InteractionProps
+ * @property {ConstructorParameters<typeof OLInteraction>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {InteractionProps | Object<string, any>} props The interaction props.
+ */
 export default function Interaction(props) {
   return createElement('interaction', {cls: OLInteraction, ...props});
 }

package/interaction/KeyboardPan.js

@@ -17,6 +17,14 @@
 import OLKeyboardPan from 'ol/interaction/KeyboardPan.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} KeyboardPanProps
+ * @property {ConstructorParameters<typeof OLKeyboardPan>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {KeyboardPanProps | Object<string, any>} props The interaction props.
+ */
 export default function KeyboardPan(props) {
   return createElement('interaction', {cls: OLKeyboardPan, ...props});
 }

package/interaction/KeyboardZoom.js

@@ -17,6 +17,14 @@
 import OLKeyboardZoom from 'ol/interaction/KeyboardZoom.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} KeyboardZoomProps
+ * @property {ConstructorParameters<typeof OLKeyboardZoom>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {KeyboardZoomProps | Object<string, any>} props The interaction props.
+ */
 export default function KeyboardZoom(props) {
   return createElement('interaction', {cls: OLKeyboardZoom, ...props});
 }

package/interaction/Link.js

@@ -17,6 +17,14 @@
 import OLLink from 'ol/interaction/Link.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} LinkProps
+ * @property {ConstructorParameters<typeof OLLink>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {LinkProps | Object<string, any>} props The interaction props.
+ */
 export default function Link(props) {
   return createElement('interaction', {cls: OLLink, ...props});
 }

package/interaction/Modify.js

@@ -17,6 +17,14 @@
 import OLModify from 'ol/interaction/Modify.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} ModifyProps
+ * @property {ConstructorParameters<typeof OLModify>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {ModifyProps | Object<string, any>} props The interaction props.
+ */
 export default function Modify(props) {
   return createElement('interaction', {cls: OLModify, ...props});
 }

package/interaction/MouseWheelZoom.js

@@ -17,6 +17,14 @@
 import OLMouseWheelZoom from 'ol/interaction/MouseWheelZoom.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} MouseWheelZoomProps
+ * @property {ConstructorParameters<typeof OLMouseWheelZoom>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {MouseWheelZoomProps | Object<string, any>} props The interaction props.
+ */
 export default function MouseWheelZoom(props) {
   return createElement('interaction', {cls: OLMouseWheelZoom, ...props});
 }

package/interaction/PinchRotate.js

@@ -17,6 +17,14 @@
 import OLPinchRotate from 'ol/interaction/PinchRotate.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} PinchRotateProps
+ * @property {ConstructorParameters<typeof OLPinchRotate>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {PinchRotateProps | Object<string, any>} props The interaction props.
+ */
 export default function PinchRotate(props) {
   return createElement('interaction', {cls: OLPinchRotate, ...props});
 }

package/interaction/PinchZoom.js

@@ -17,6 +17,14 @@
 import OLPinchZoom from 'ol/interaction/PinchZoom.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} PinchZoomProps
+ * @property {ConstructorParameters<typeof OLPinchZoom>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {PinchZoomProps | Object<string, any>} props The interaction props.
+ */
 export default function PinchZoom(props) {
   return createElement('interaction', {cls: OLPinchZoom, ...props});
 }

package/interaction/Pointer.js

@@ -17,6 +17,14 @@
 import OLPointer from 'ol/interaction/Pointer.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} PointerProps
+ * @property {ConstructorParameters<typeof OLPointer>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {PointerProps | Object<string, any>} props The interaction props.
+ */
 export default function Pointer(props) {
   return createElement('interaction', {cls: OLPointer, ...props});
 }

package/interaction/Select.js

@@ -17,6 +17,14 @@
 import OLSelect from 'ol/interaction/Select.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} SelectProps
+ * @property {ConstructorParameters<typeof OLSelect>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {SelectProps | Object<string, any>} props The interaction props.
+ */
 export default function Select(props) {
   return createElement('interaction', {cls: OLSelect, ...props});
 }

package/interaction/Snap.js

@@ -17,6 +17,14 @@
 import OLSnap from 'ol/interaction/Snap.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} SnapProps
+ * @property {ConstructorParameters<typeof OLSnap>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {SnapProps | Object<string, any>} props The interaction props.
+ */
 export default function Snap(props) {
   return createElement('interaction', {cls: OLSnap, ...props});
 }

package/interaction/Translate.js

@@ -17,6 +17,14 @@
 import OLTranslate from 'ol/interaction/Translate.js';
 import {createElement} from 'react';
 
+/**
+ * @typedef {Object} TranslateProps
+ * @property {ConstructorParameters<typeof OLTranslate>[0]} [options] The interaction options.
+ */
+
+/**
+ * @param {TranslateProps | Object<string, any>} props The interaction props.
+ */
 export default function Translate(props) {
   return createElement('interaction', {cls: OLTranslate, ...props});
 }

package/internal/config.js

@@ -22,6 +22,7 @@ export const directories = {
 
 // Modules in this list will be ignored when generating components.
 export const ignore = [
+  'interaction/Property.js',
   'layer/Property.js',
   'layer/TileProperty.js',
   'layer/VectorTileRenderType.js',