@open-pioneer/map 0.3.0 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @open-pioneer/map
 
+## 0.3.1
+
+### Patch Changes
+
+-   611ddb9: Export interface `BaseFeature` from Map API and use it correctly in base packages `selection` and `search`.
+
 ## 0.3.0
 
 ### Minor Changes

package/api/BaseFeature.d.ts

@@ -0,0 +1,31 @@
+import { Geometry } from "ol/geom";
+import { Style } from "ol/style";
+/**
+ * Base interface for all feature objects with geometry and / or attributs information.
+ */
+export interface BaseFeature {
+    /**
+     * Identifier for the feature object. Must be unique within all features of one source/layer.
+     *
+     * If your source cannot provide a useful id on its own, another strategy to generate unique ids is to
+     * generate a [UUID](https://www.npmjs.com/package/uuid#uuidv4options-buffer-offset) instead.
+     */
+    id: number | string;
+    /**
+     * Geometry of the feature.
+     * Also specify the {@link projection} if geometry is set.
+     */
+    geometry?: Geometry;
+    /**
+     * The projection of the {@link geometry}.
+     */
+    projection?: string;
+    /**
+     * Properties of the feature.
+     */
+    properties?: Readonly<Record<string, unknown>>;
+    /**
+     * Additional style information for displaying the feature on the map.
+     */
+    style?: Style;
+}

package/api/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./BaseFeature";
 export * from "./MapConfig";
 export * from "./MapModel";
 export * from "./MapRegistry";
@@ -5,7 +6,7 @@ export * from "./layers";
 export * from "./shared";
 export { getProjection, registerProjections, type ProjectionDefinition } from "../projections";
 export { BkgTopPlusOpen, type BkgTopPlusOpenProps } from "../layers/BkgTopPlusOpen";
-export { useCenter, useProjection, useResolution, useScale } from "../ui/hooks";
+export { useView, useProjection, useResolution, useCenter, useScale } from "../ui/hooks";
 export { MapAnchor, type MapAnchorProps, type MapAnchorPosition } from "../ui/MapAnchor";
 export { MapContainer, type MapContainerProps } from "../ui/MapContainer";
 export { useMapModel, type UseMapModelResult, type UseMapModelLoading, type UseMapModelResolved, type UseMapModelRejected } from "../ui/useMapModel";

package/index.js

@@ -3,7 +3,7 @@ export { WMSLayer } from './api/layers/WMSLayer.js';
 export { WMTSLayer } from './api/layers/WMTSLayer.js';
 export { getProjection, registerProjections } from './projections.js';
 export { BkgTopPlusOpen } from './layers/BkgTopPlusOpen.js';
-export { useCenter, useProjection, useResolution, useScale } from './ui/hooks.js';
+export { useCenter, useProjection, useResolution, useScale, useView } from './ui/hooks.js';
 export { MapAnchor } from './ui/MapAnchor.js';
 export { MapContainer } from './ui/MapContainer.js';
 export { useMapModel } from './ui/useMapModel.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@open-pioneer/map",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "license": "Apache-2.0",
   "dependencies": {
     "uuid": "^9.0.1"