@planet/maps 8.0.0-dev.1675704426846 → 8.0.0-dev.1675901329705

package/lib/Map.js

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 import OLMap from 'ol/Map.js';
+import propTypes from 'prop-types';
 import {Component, createElement, createRef, forwardRef} from 'react';
-import {any, func, node, object, oneOfType, shape, string} from 'prop-types';
 import {render, updateInstanceFromProps} from '../renderer/render.js';
 
 const defaultDivStyle = {
@@ -58,11 +58,14 @@ class Map extends Component {
 }
 
 Map.propTypes = {
-  className: string,
-  id: string,
-  style: object,
-  children: node,
-  innerRef: oneOfType([func, shape({current: any})]),
+  className: propTypes.string,
+  id: propTypes.string,
+  style: propTypes.object,
+  children: propTypes.node,
+  innerRef: propTypes.oneOfType([
+    propTypes.func,
+    propTypes.shape({current: propTypes.any}),
+  ]),
 };
 
 export default forwardRef((props, ref) =>

package/lib/layer/Base.js

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 import OLBase from 'ol/layer/Base.js';
+import propTypes from 'prop-types';
 import {createElement, forwardRef} from 'react';
-import {node} from 'prop-types';
 
 const Base = forwardRef(({children, ...props}, ref) => {
   return createElement('layer', {cls: OLBase, ref, ...props}, children);
 });
 
 Base.propTypes = {
-  children: node,
+  children: propTypes.node,
 };
 
 export default Base;

package/lib/layer/BaseImage.js

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 import OLBaseImage from 'ol/layer/BaseImage.js';
+import propTypes from 'prop-types';
 import {createElement, forwardRef} from 'react';
-import {node} from 'prop-types';
 
 const BaseImage = forwardRef(({children, ...props}, ref) => {
   return createElement('layer', {cls: OLBaseImage, ref, ...props}, children);
 });
 
 BaseImage.propTypes = {
-  children: node,
+  children: propTypes.node,
 };
 
 export default BaseImage;

package/lib/layer/BaseTile.js

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 import OLBaseTile from 'ol/layer/BaseTile.js';
+import propTypes from 'prop-types';
 import {createElement, forwardRef} from 'react';
-import {node} from 'prop-types';
 
 const BaseTile = forwardRef(({children, ...props}, ref) => {
   return createElement('layer', {cls: OLBaseTile, ref, ...props}, children);
 });
 
 BaseTile.propTypes = {
-  children: node,
+  children: propTypes.node,
 };
 
 export default BaseTile;

package/lib/layer/BaseVector.js

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 import OLBaseVector from 'ol/layer/BaseVector.js';
+import propTypes from 'prop-types';
 import {createElement, forwardRef} from 'react';
-import {node} from 'prop-types';
 
 const BaseVector = forwardRef(({children, ...props}, ref) => {
   return createElement('layer', {cls: OLBaseVector, ref, ...props}, children);
 });
 
 BaseVector.propTypes = {
-  children: node,
+  children: propTypes.node,
 };
 
 export default BaseVector;

package/lib/layer/Graticule.js

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 import OLGraticule from 'ol/layer/Graticule.js';
+import propTypes from 'prop-types';
 import {createElement, forwardRef} from 'react';
-import {node} from 'prop-types';
 
 const Graticule = forwardRef(({children, ...props}, ref) => {
   return createElement('layer', {cls: OLGraticule, ref, ...props}, children);
 });
 
 Graticule.propTypes = {
-  children: node,
+  children: propTypes.node,
 };
 
 export default Graticule;

package/lib/layer/Group.js

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 import OLGroup from 'ol/layer/Group.js';
+import propTypes from 'prop-types';
 import {createElement, forwardRef} from 'react';
-import {node} from 'prop-types';
 
 const Group = forwardRef(({children, ...props}, ref) => {
   return createElement('layer', {cls: OLGroup, ref, ...props}, children);
 });
 
 Group.propTypes = {
-  children: node,
+  children: propTypes.node,
 };
 
 export default Group;

package/lib/layer/Heatmap.js

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 import OLHeatmap from 'ol/layer/Heatmap.js';
+import propTypes from 'prop-types';
 import {createElement, forwardRef} from 'react';
-import {node} from 'prop-types';
 
 const Heatmap = forwardRef(({children, ...props}, ref) => {
   return createElement('layer', {cls: OLHeatmap, ref, ...props}, children);
 });
 
 Heatmap.propTypes = {
-  children: node,
+  children: propTypes.node,
 };
 
 export default Heatmap;

package/lib/layer/Image.js

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 import OLImage from 'ol/layer/Image.js';
+import propTypes from 'prop-types';
 import {createElement, forwardRef} from 'react';
-import {node} from 'prop-types';
 
 const Image = forwardRef(({children, ...props}, ref) => {
   return createElement('layer', {cls: OLImage, ref, ...props}, children);
 });
 
 Image.propTypes = {
-  children: node,
+  children: propTypes.node,
 };
 
 export default Image;

package/lib/layer/Layer.js

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 import OLLayer from 'ol/layer/Layer.js';
+import propTypes from 'prop-types';
 import {createElement, forwardRef} from 'react';
-import {node} from 'prop-types';
 
 const Layer = forwardRef(({children, ...props}, ref) => {
   return createElement('layer', {cls: OLLayer, ref, ...props}, children);
 });
 
 Layer.propTypes = {
-  children: node,
+  children: propTypes.node,
 };
 
 export default Layer;

package/lib/layer/MapboxVector.js

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 import OLMapboxVector from 'ol/layer/MapboxVector.js';
+import propTypes from 'prop-types';
 import {createElement, forwardRef} from 'react';
-import {node} from 'prop-types';
 
 const MapboxVector = forwardRef(({children, ...props}, ref) => {
   return createElement('layer', {cls: OLMapboxVector, ref, ...props}, children);
 });
 
 MapboxVector.propTypes = {
-  children: node,
+  children: propTypes.node,
 };
 
 export default MapboxVector;

package/lib/layer/Tile.js

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 import OLTile from 'ol/layer/Tile.js';
+import propTypes from 'prop-types';
 import {createElement, forwardRef} from 'react';
-import {node} from 'prop-types';
 
 const Tile = forwardRef(({children, ...props}, ref) => {
   return createElement('layer', {cls: OLTile, ref, ...props}, children);
 });
 
 Tile.propTypes = {
-  children: node,
+  children: propTypes.node,
 };
 
 export default Tile;

package/lib/layer/Vector.js

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 import OLVector from 'ol/layer/Vector.js';
+import propTypes from 'prop-types';
 import {createElement, forwardRef} from 'react';
-import {node} from 'prop-types';
 
 const Vector = forwardRef(({children, ...props}, ref) => {
   return createElement('layer', {cls: OLVector, ref, ...props}, children);
 });
 
 Vector.propTypes = {
-  children: node,
+  children: propTypes.node,
 };
 
 export default Vector;

package/lib/layer/VectorImage.js

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 import OLVectorImage from 'ol/layer/VectorImage.js';
+import propTypes from 'prop-types';
 import {createElement, forwardRef} from 'react';
-import {node} from 'prop-types';
 
 const VectorImage = forwardRef(({children, ...props}, ref) => {
   return createElement('layer', {cls: OLVectorImage, ref, ...props}, children);
 });
 
 VectorImage.propTypes = {
-  children: node,
+  children: propTypes.node,
 };
 
 export default VectorImage;

package/lib/layer/VectorTile.js

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 import OLVectorTile from 'ol/layer/VectorTile.js';
+import propTypes from 'prop-types';
 import {createElement, forwardRef} from 'react';
-import {node} from 'prop-types';
 
 const VectorTile = forwardRef(({children, ...props}, ref) => {
   return createElement('layer', {cls: OLVectorTile, ref, ...props}, children);
 });
 
 VectorTile.propTypes = {
-  children: node,
+  children: propTypes.node,
 };
 
 export default VectorTile;

package/lib/layer/WebGLPoints.js

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 import OLWebGLPoints from 'ol/layer/WebGLPoints.js';
+import propTypes from 'prop-types';
 import {createElement, forwardRef} from 'react';
-import {node} from 'prop-types';
 
 const WebGLPoints = forwardRef(({children, ...props}, ref) => {
   return createElement('layer', {cls: OLWebGLPoints, ref, ...props}, children);
 });
 
 WebGLPoints.propTypes = {
-  children: node,
+  children: propTypes.node,
 };
 
 export default WebGLPoints;

package/lib/layer/WebGLTile.js

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 import OLWebGLTile from 'ol/layer/WebGLTile.js';
+import propTypes from 'prop-types';
 import {createElement, forwardRef} from 'react';
-import {node} from 'prop-types';
 
 const WebGLTile = forwardRef(({children, ...props}, ref) => {
   return createElement('layer', {cls: OLWebGLTile, ref, ...props}, children);
 });
 
 WebGLTile.propTypes = {
-  children: node,
+  children: propTypes.node,
 };
 
 export default WebGLTile;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planet/maps",
-  "version": "8.0.0-dev.1675704426846",
+  "version": "8.0.0-dev.1675901329705",
   "description": "Declarative mapping components for React",
   "type": "module",
   "scripts": {
@@ -9,9 +9,9 @@
     "test:unit": "vitest run -r ./tests/unit",
     "lint": "eslint .",
     "test:rendering": "playwright test --config=tests/rendering/playwright.config.js",
-    "start": "vite serve",
+    "start": "astro dev --root ./site",
     "start:rendering": "vite serve --config=tests/rendering/vite.config.js",
-    "build": "vite build",
+    "build": "astro build --root ./site",
     "generate": "node tools/generate.js && npm run lint -- --fix",
     "clean": "node tools/clean.js"
   },
@@ -25,12 +25,20 @@
     "react-reconciler": "^0.29.0"
   },
   "devDependencies": {
+    "@astrojs/mdx": "^0.16.0",
+    "@astrojs/react": "^2.0.2",
     "@octokit/rest": "^19.0.5",
     "@playwright/test": "^1.25.2",
+    "@types/react": "^18.0.27",
+    "@types/react-dom": "^18.0.10",
+    "astro": "^2.0.8",
     "c8": "^7.12.0",
     "es-main": "^1.2.0",
-    "eslint": "^8.23.1",
+    "eslint": "^8.32.0",
     "eslint-config-planet": "^20.0.3",
+    "eslint-plugin-astro": "^0.23.0",
+    "eslint-plugin-mdx": "^2.0.5",
+    "eslint-plugin-react": "^7.32.1",
     "fs-extra": "^11.1.0",
     "import-meta-resolve": "^2.0.2",
     "jsdom": "^21.0.0",
@@ -38,24 +46,67 @@
     "mustache": "^4.2.0",
     "ol": "^7.1.0",
     "prop-types": "^15.8.1",
-    "react-dom": "^18.1.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "remark-html": "^15.0.2",
+    "remark-parse": "^10.0.1",
     "semapro": "^1.1.0",
     "semver": "^7.3.7",
-    "vite": "^4.0.0",
+    "shiki": "^0.11.0",
+    "unified": "^10.1.2",
+    "vite": "^4.0.4",
     "vitest": "^0.28.3"
   },
   "eslintConfig": {
-    "extends": "planet/react",
+    "extends": [
+      "planet"
+    ],
+    "parserOptions": {
+      "ecmaVersion": "latest",
+      "sourceType": "module"
+    },
+    "rules": {
+      "import/named": "off",
+      "import/default": "off",
+      "import/no-unresolved": [
+        "error",
+        {
+          "ignore": [
+            "astro:content",
+            "@astrojs/*"
+          ]
+        }
+      ]
+    },
     "overrides": [
       {
         "files": [
-          "*.jsx",
-          "*.js"
+          "*.astro"
+        ],
+        "extends": [
+          "plugin:astro/recommended"
+        ]
+      },
+      {
+        "files": [
+          "*.jsx"
+        ],
+        "extends": [
+          "planet/react"
+        ],
+        "rules": {
+          "import/named": "off"
+        }
+      },
+      {
+        "files": [
+          "*.mdx"
+        ],
+        "extends": [
+          "plugin:mdx/recommended",
+          "planet/react"
         ]
       }
-    ],
-    "parserOptions": {
-      "ecmaVersion": "latest"
-    }
+    ]
   }
 }

package/readme.md

@@ -10,29 +10,7 @@ Declarative mapping components
 npm install @planet/maps
 ```
 
-Import the components you need for your map.  Provide an `options` prop to pass to the underlying OpenLayers constructor.  Provide other props for values that you want to update with state changes.
-
-```js
-import Map from '@planet/maps/lib/Map';
-import OSM from '@planet/maps/lib/source/OSM';
-import ScaleLine from '@planet/maps/lib/control/ScaleLine';
-import View from '@planet/maps/lib/View';
-import WebGLTile from '@planet/maps/lib/layer/WebGLTile';
-
-function MyApp() {
-  return (
-    <Map style={{width: '100%', height: '100%'}}>
-      <View options={{center: [0, 0], zoom: 1}} />
-      <WebGLTile>
-        <OSM />
-      </WebGLTile>
-      <ScaleLine />
-    </Map>
-  );
-}
-```
-
-You can also listen to any events on the map, view, controls, interactions, layers, or sources; use `ref`s to get access to the underlying OpenLayers instances; and more.
+See the [planetlabs.github.io/maps](https://planetlabs.github.io/maps/) website for more details and examples using the library.
 
 ## Background
 
@@ -73,6 +51,16 @@ Install project dependencies:
 npm install
 ```
 
+Start the development server:
+```bash
+npm start
+```
+
+Run the tests:
+```bash
+npm test
+```
+
 The rendering tests use Playwright for visual snapshot comparison.  See the [`tests/rendering/readme.md`](tests/rendering/readme.md) for more detail.