@geospatial-sdk/openlayers 0.0.5-dev.44 → 0.0.5-dev.46

package/README.md

@@ -1,11 +1,42 @@
-# `openlayers`
+# `@geospatial-sdk/openlayers`
 
-> TODO: description
+<!-- #region body -->
 
-## Usage
+This package provides utilities to create and manage [OpenLayers](https://openlayers.org/) maps using the declarative Map Context model from `@geospatial-sdk/core`.
+
+## Installation
 
+```sh
+npm install @geospatial-sdk/openlayers
 ```
-const openlayers = require('openlayers');
 
-// TODO: DEMONSTRATE API
+## Usage
+
+```typescript
+import { createMapFromContext } from "@geospatial-sdk/openlayers";
+import type { MapContext } from "@geospatial-sdk/core";
+
+const mapContext: MapContext = {
+  layers: [
+    {
+      type: "xyz",
+      url: "https://tile.openstreetmap.org/{z}/{x}/{y}.png",
+    },
+  ],
+  view: {
+    center: [6, 48.5],
+    zoom: 5,
+  },
+};
+
+const map = await createMapFromContext(
+  mapContext,
+  document.getElementById("map"),
+);
 ```
+
+<!-- #endregion body -->
+
+## Documentation
+
+For more detailed API documentation, see the [documentation website](https://camptocamp.github.io/geospatial-sdk/docs/).

package/dist/index.d.ts

@@ -1,2 +1,7 @@
+/**
+ * {@include ../README.md#body}
+ *
+ * @module 📦 openlayers
+ */
 export * from "./map/index.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AACA,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,gBAAgB,CAAC"}

package/dist/index.js

@@ -1,2 +1,6 @@
-// PUBLIC API
+/**
+ * {@include ../README.md#body}
+ *
+ * @module 📦 openlayers
+ */
 export * from "./map/index.js";

package/dist/map/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @hideGroups
+ * @packageDocumentation
+ */
 export * from "./styles.js";
 export { createMapFromContext, resetMapFromContext } from "./create-map.js";
 export { applyContextDiffToMap } from "./apply-context-diff.js";

package/dist/map/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/map/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/map/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/map/index.js

@@ -1,3 +1,7 @@
+/**
+ * @hideGroups
+ * @packageDocumentation
+ */
 export * from "./styles.js";
 export { createMapFromContext, resetMapFromContext } from "./create-map.js";
 export { applyContextDiffToMap } from "./apply-context-diff.js";

package/lib/index.ts

@@ -1,2 +1,7 @@
-// PUBLIC API
+/**
+ * {@include ../README.md#body}
+ *
+ * @module 📦 openlayers
+ */
+
 export * from "./map/index.js";

package/lib/map/index.ts

@@ -1,3 +1,8 @@
+/**
+ * @hideGroups
+ * @packageDocumentation
+ */
+
 export * from "./styles.js";
 export { createMapFromContext, resetMapFromContext } from "./create-map.js";
 export { applyContextDiffToMap } from "./apply-context-diff.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geospatial-sdk/openlayers",
-  "version": "0.0.5-dev.44+44c94a2",
+  "version": "0.0.5-dev.46+b8d315e",
   "description": "OpenLayers-related utilities",
   "keywords": [
     "ol",
@@ -37,10 +37,10 @@
     "ol": ">6.x"
   },
   "dependencies": {
-    "@geospatial-sdk/core": "^0.0.5-dev.44+44c94a2",
+    "@geospatial-sdk/core": "^0.0.5-dev.46+b8d315e",
     "chroma-js": "^2.4.2",
     "lodash.throttle": "^4.1.1",
     "ol-mapbox-style": "12.4.0"
   },
-  "gitHead": "44c94a2e3458beb7e3f3ffc98ed170c21a0fc460"
+  "gitHead": "b8d315eaf71bccb50823f6e11c18c045ab1b6c5d"
 }