refactor: update boundary type to be equal to the implementation in #374

Author: dopenguin

src/core/types/plugin.ts

@@ -24,30 +24,36 @@ export interface PluginOptions {
 	layoutTag?: keyof typeof NineLayoutTag
 }
 
-export type BoundaryOnError = 'strict' | 'permissive'
-
-export interface LayerBoundPluginOptions extends PluginOptions {
+interface BoundaryOptions {
 	/**
-	 * Set to check whether something is within the layer's boundaries.
+	 * ID of the vector layer to restrict requests to.
 	 * The layer must contain vectors. This is useful for restricted maps to avoid
 	 * selecting unfit coordinates.
 	 */
-	boundaryLayerId?: string
+	layerId: string
+
+	/**
+	 * If the boundary layer check does not work due to loading or configuration
+	 * errors, style `'strict'` will disable the affected feature, and style
+	 * `'permissive'` will act as if no {@link layerId} was set.
+	 *
+	 * @defaultValue 'permissive'
+	 */
+	onError?: 'strict' | 'permissive'
 
 	/**
 	 * If the boundary layer check does not work due to loading or configuration
 	 * errors, style `'strict'` will disable the affected feature, and style
 	 * `'permissive'` will act as if no boundaryLayerId was set.
 	 * @defaultValue `'permissive'`
 	 */
+}
 
-	boundaryOnError?: BoundaryOnError
-
+export interface LayerBoundPluginOptions extends PluginOptions {
 	/**
-	 * Whether the user should, in error cases, be informed with a toast.
-	 * @defaultValue `false`
+	 * Set to check whether something is within the layer's boundaries.
 	 */
-	toast?: boolean
+	boundary?: BoundaryOptions
 }
 
 export type PolarPluginStore<

src/plugins/geoLocation/store.ts

@@ -157,7 +157,7 @@ export const useGeoLocationStore = defineStore('plugins/geoLocation', () => {
 
 		const boundaryCheckPassed = await passesBoundaryCheck(
 			coreStore.map,
-			configuration.value.boundaryLayerId,
+			configuration.value.boundary.layerId,
 			coordinatesInMapCrs
 		)
 
@@ -166,7 +166,7 @@ export const useGeoLocationStore = defineStore('plugins/geoLocation', () => {
 
 		const showBoundaryLayerError =
 			typeof boundaryCheckPassed === 'symbol' &&
-			configuration.value.boundaryOnError === 'strict'
+			configuration.value.boundary.onError === 'strict'
 
 		if (!isCoordinateInExtent || showBoundaryLayerError) {
 			printPositioningFailed(showBoundaryLayerError)
@@ -314,26 +314,31 @@ export const useGeoLocationStore = defineStore('plugins/geoLocation', () => {
 	return {
 		/** @internal */
 		setupPlugin,
+
 		/** @internal */
 		teardownPlugin,
+
 		/**
 		 * The plugin's current state. It can either currently have the user's
 		 * position ('LOCATED'), be ready to retrieve it ('LOCATABLE'), or be
 		 * disabled ('DISABLED') due to the user or browser settings not allowing
 		 * the Geolocation API access.
 		 */
 		state,
+
 		/**
 		 * The action that would currently unfold upon clicking the icon, depending
 		 * on the state. If the state is 'DISABLED', nothing is done. In the other
 		 * states, the geolocation procedure is (re-)run.
 		 */
 		action,
+
 		/**
 		 * While in state 'LOCATED', the user's location's coordinated are available
 		 * as [number, number] of the map's configured CRS.
 		 */
 		position,
+
 		/**
 		 * Initially null. If no boundary check is configured or the check is
 		 * passed, this field holds `true`. If the boundary check is not passed,