@planet/maps 7.1.1-alpha-heat → 8.0.0-dev.1666714337006

package/lib/source/OGCVectorTile.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLOGCVectorTile from 'ol/source/OGCVectorTile.js';
+import {createElement, forwardRef} from 'react';
+
+const OGCVectorTile = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLOGCVectorTile, ref, ...props});
+});
+
+export default OGCVectorTile;

package/lib/source/OSM.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLOSM from 'ol/source/OSM.js';
+import {createElement, forwardRef} from 'react';
+
+const OSM = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLOSM, ref, ...props});
+});
+
+export default OSM;

package/lib/source/Raster.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLRaster from 'ol/source/Raster.js';
+import {createElement, forwardRef} from 'react';
+
+const Raster = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLRaster, ref, ...props});
+});
+
+export default Raster;

package/lib/source/Source.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLSource from 'ol/source/Source.js';
+import {createElement, forwardRef} from 'react';
+
+const Source = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLSource, ref, ...props});
+});
+
+export default Source;

package/lib/source/Stamen.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLStamen from 'ol/source/Stamen.js';
+import {createElement, forwardRef} from 'react';
+
+const Stamen = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLStamen, ref, ...props});
+});
+
+export default Stamen;

package/lib/source/Tile.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLTile from 'ol/source/Tile.js';
+import {createElement, forwardRef} from 'react';
+
+const Tile = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLTile, ref, ...props});
+});
+
+export default Tile;

package/lib/source/TileArcGISRest.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLTileArcGISRest from 'ol/source/TileArcGISRest.js';
+import {createElement, forwardRef} from 'react';
+
+const TileArcGISRest = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLTileArcGISRest, ref, ...props});
+});
+
+export default TileArcGISRest;

package/lib/source/TileDebug.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLTileDebug from 'ol/source/TileDebug.js';
+import {createElement, forwardRef} from 'react';
+
+const TileDebug = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLTileDebug, ref, ...props});
+});
+
+export default TileDebug;

package/lib/source/TileImage.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLTileImage from 'ol/source/TileImage.js';
+import {createElement, forwardRef} from 'react';
+
+const TileImage = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLTileImage, ref, ...props});
+});
+
+export default TileImage;

package/lib/source/TileJSON.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLTileJSON from 'ol/source/TileJSON.js';
+import {createElement, forwardRef} from 'react';
+
+const TileJSON = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLTileJSON, ref, ...props});
+});
+
+export default TileJSON;

package/lib/source/TileWMS.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLTileWMS from 'ol/source/TileWMS.js';
+import {createElement, forwardRef} from 'react';
+
+const TileWMS = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLTileWMS, ref, ...props});
+});
+
+export default TileWMS;

package/lib/source/UTFGrid.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLUTFGrid from 'ol/source/UTFGrid.js';
+import {createElement, forwardRef} from 'react';
+
+const UTFGrid = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLUTFGrid, ref, ...props});
+});
+
+export default UTFGrid;

package/lib/source/UrlTile.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLUrlTile from 'ol/source/UrlTile.js';
+import {createElement, forwardRef} from 'react';
+
+const UrlTile = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLUrlTile, ref, ...props});
+});
+
+export default UrlTile;

package/lib/source/Vector.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLVector from 'ol/source/Vector.js';
+import {createElement, forwardRef} from 'react';
+
+const Vector = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLVector, ref, ...props});
+});
+
+export default Vector;

package/lib/source/VectorTile.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLVectorTile from 'ol/source/VectorTile.js';
+import {createElement, forwardRef} from 'react';
+
+const VectorTile = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLVectorTile, ref, ...props});
+});
+
+export default VectorTile;

package/lib/source/WMTS.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLWMTS from 'ol/source/WMTS.js';
+import {createElement, forwardRef} from 'react';
+
+const WMTS = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLWMTS, ref, ...props});
+});
+
+export default WMTS;

package/lib/source/XYZ.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLXYZ from 'ol/source/XYZ.js';
+import {createElement, forwardRef} from 'react';
+
+const XYZ = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLXYZ, ref, ...props});
+});
+
+export default XYZ;

package/lib/source/Zoomify.js

@@ -0,0 +1,24 @@
+// This file is generated by tools/generate.js. DO NOT EDIT.
+/**
+ * Copyright 2022 Planet Labs PBC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import OLZoomify from 'ol/source/Zoomify.js';
+import {createElement, forwardRef} from 'react';
+
+const Zoomify = forwardRef((props, ref) => {
+  return createElement('source', {cls: OLZoomify, ref, ...props});
+});
+
+export default Zoomify;

package/package.json

@@ -1,26 +1,61 @@
 {
   "name": "@planet/maps",
-  "version": "7.1.1-alpha-heat",
-  "description": "Custom builds of OpenLayers 3",
-  "homepage": "https://github.com/planetlabs/maps",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/planetlabs/maps.git"
-  },
-  "bugs": {
-    "url": "https://github.com/planetlabs/maps/issues"
-  },
-  "main": "common.js",
+  "version": "8.0.0-dev.1666714337006",
+  "description": "Declarative mapping components for React",
+  "type": "module",
   "scripts": {
-    "prepublish": "in-publish && make || not-in-publish"
+    "pretest": "npm run lint",
+    "test": "npm run test:rendering",
+    "test:unit": "vitest run -r ./tests/unit",
+    "lint": "eslint .",
+    "test:rendering": "playwright test --config=tests/rendering/playwright.config.js",
+    "start": "vite serve",
+    "start:rendering": "vite serve --config=tests/rendering/vite.config.js",
+    "build": "vite build",
+    "generate": "node tools/generate.js && npm run lint -- --fix",
+    "clean": "node tools/clean.js"
   },
   "license": "Apache-2.0",
-  "keywords": [
-    "openlayers",
-    "ol3"
+  "files": [
+    "config.js",
+    "lib",
+    "renderer"
   ],
+  "dependencies": {
+    "react-reconciler": "^0.29.0"
+  },
   "devDependencies": {
-    "in-publish": "2.0.0",
-    "openlayers": "3.20.0"
+    "@octokit/rest": "^19.0.5",
+    "@playwright/test": "^1.25.2",
+    "c8": "^7.12.0",
+    "es-main": "^1.2.0",
+    "eslint": "^8.23.1",
+    "eslint-config-planet": "^20.0.3",
+    "fs-extra": "^10.1.0",
+    "import-meta-resolve": "^2.0.2",
+    "jsdom": "^20.0.0",
+    "minimist": "^1.2.6",
+    "mustache": "^4.2.0",
+    "ol": "^7.1.0",
+    "prop-types": "^15.8.1",
+    "react-dom": "^18.1.0",
+    "semapro": "^1.1.0",
+    "semver": "^7.3.7",
+    "vite": "^3.1.0",
+    "vitest": "^0.24.0"
+  },
+  "eslintConfig": {
+    "extends": "planet/react",
+    "overrides": [
+      {
+        "files": [
+          "*.jsx",
+          "*.js"
+        ]
+      }
+    ],
+    "parserOptions": {
+      "ecmaVersion": "latest"
+    }
   }
 }

package/readme.md

@@ -1,60 +1,79 @@
-# Planet Maps
+# @planet/maps
 
-Custom builds of OpenLayers 3.
+Declarative mapping components
 
 ## Use
 
-Install `planet-maps` as a dependency with [`npm`](http://nodejs.org/).
-
-    npm install planet-maps --save-dev
+```
+npm install @planet/maps
+```
 
-Use [Browserify](http://browserify.org/) to `require` OpenLayers 3.
+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
-// see below for a list of custom builds
-var ol = require('@planet/maps/common');
+import Map from '@planet/maps/lib/Map';
+import OSM from '@planet/maps/source/OSM';
+import ScaleLine from '@planet/maps/control/ScaleLine';
+import View from '@planet/maps/lib/View';
+import WebGLTile from '@planet/maps/layer/WebGLTile';
+
+function MyApp() {
+  return (
+    <Map style={{width: '100%', height: '100%'}}>
+      <View options={{center: [0, 0], zoom: 1}} />
+      <WebGLTile>
+        <OSM />
+      </WebGLTile>
+      <ScaleLine />
+    </Map>
+  );
+}
 ```
 
-You'll also want to import the stylesheet:
+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.
 
-```css
-/* Make sure to use the path to your node_modules */
-@import url('./node_modules/planet-maps/ol.css');
-```
+## Background
 
-## Builds
+React lets you build interactive UIs with (mostly) declarative syntax.  OpenLayers provides an imperative API for building mapping apps.  It can be awkward to map React's component API to an imperative API.  However, the React team provides a package for creating custom renderers: [`react-reconciler`](https://www.npmjs.com/package/react-reconciler).  This is how they integrate with imperative APIs themselves.  The `react-dom` package uses `react-reconciler` to provide a mapping to the imperative DOM API.  `react-native` uses `react-reconciler` to map to imperative native APIs.
 
-### `common`
+This library provides declarative mapping components representing imperative APIs from OpenLayers.
 
-```js
-var ol = require('@planet/maps/common');
-```
+## Design Goals
 
-Support for everything required by Scenes, Mosaics, Labs, etc.  See `config/common.json` for details on what is included.
+The purpose of this project is to provide a mapping between React's declarative components and OpenLayers' imperative API.  In other words, this project provides a React renderer for OpenLayers.
 
-### `explorer`
+Here are some of the goals of this project:
 
-```js
-var ol = require('@planet/maps/explorer');
-```
+  * Ideally, the renderer would not have any additional dependencies beyond what is bundled with an OpenLayers map.
+  * Components exported by this package map 1:1 with classes exported by OpenLayers.
+  * Component props map directly to properties that are settable on instances of OpenLayers classes.  Exceptions to this are props like `options` (passed to the constructor only), listener props (e.g. `onChange`), and `ref`.
+  * Components accept a `ref` that provide access to the underlying OpenLayers instance.
+  * The renderer should add negligible overhead in terms of bundle size, memory consumption, or processing.
+  * Code components can be generated by using OpenLayers sources.  Exceptions to this are the map component (responsible for invoking the custom renderer) and components that map to classes without subclasses (e.g. the view).
+
+## Non-Goals
 
-Support for everything required by Planet Explorer.  See `config/explorer.json` for details on what is included.
+This project does not intend to provide any of the following:
 
-### `debug`
+ * Higher level abstractions or components that combine logic from multiple OpenLayers instances (e.g. an editable layer component that wraps a layer, source, and editing interactions).
+ * Styled widgets (e.g. a layer switcher/browser).
+ * Other utilities for working with vector data, projections, etc.
 
-This is a debug build that should never be used in production.
+We hope that this package can provide the foundation for other, higher-level libraries with more opinions about the look and feel of mapping components.
 
-## Publishing a new release
+## Development
 
-Edit the `config` files to include what you need exported and commit the changes.  Then you'll want to bump the version number in `package.json`, commit this change, and create a tag.  This should be done with the `npm version` command (choose one of `patch`, `minor`, or `major`).  E.g.
+The development setup depends on [Node 18](https://nodejs.org/) (most things work on 16, but not all).
 
-    npm version minor
+Install project dependencies:
+
+```bash
+npm install
+```
 
-Next you'll want to push your commits (and the tag) and publish your changes to npmjs.org.
+The rendering tests use Playwright for visual snapshot comparison.  See the [`tests/rendering/readme.md`](tests/rendering/readme.md) for more detail.
 
-    git push --tags origin master
-    npm publish
 
-Before publishing, the `prepublish` step will run `make`.  This will create builds that are *not* tracked by `git` but that are pushed to the npmjs.org repository for use by consuming packages.
+## Prior Art
 
-Note the new version number in `package.json` and use it in packages that depend on this one.
+Other projects like [`react-openlayers-fiber`](https://github.com/crubier/react-openlayers-fiber) and [`react-ol-fiber`](https://www.npmjs.com/package/react-ol-fiber) use a similar approach and provided inspiration for this project.  The major difference between this project and those is that this project provides importable components for OpenLayers layers, sources, controls, and interactions.  The other projects bundle all of OpenLayers in their renderer.  So a simple "hello world" map with one of the existing projects is about 1.5 MB while the same with this project is about 460 KB.