move helper/utils out of QueryStore into utils.ts

karussell · karussell · commit a1fc70ee25e1 · 2025-04-28T12:29:56.000+02:00
diff --git a/config.js b/config.js
@@ -63,18 +63,6 @@ const config = {
     //      { profile: 'racingbike' },
     //      { profile: 'ecargobike' }
     //    ]
-    //  },
-    //  truck: {
-    //    options: [
-    //      { profile: 'small_truck' },
-    //      { profile: 'truck' }
-    //    ]
-    //  },
-    //  foot: {
-    //    options: [
-    //      { profile: 'foot' },
-    //      { profile: 'hike' }
-    //    ]
     //  }
     // }
 }
diff --git a/src/Converters.ts b/src/Converters.ts
@@ -1,6 +1,5 @@
 import { GeocodingHit } from '@/api/graphhopper'
-
-import { Coordinate } from '@/stores/QueryStore'
+import { Coordinate } from '@/utils'
 
 export function milliSecondsToText(ms: number) {
     const hours = Math.floor(ms / 3600000)
diff --git a/src/NavBar.ts b/src/NavBar.ts
@@ -3,11 +3,11 @@ import Dispatcher from '@/stores/Dispatcher'
 import { ClearPoints, SelectMapLayer, SetBBox, SetQueryPoints, SetVehicleProfile } from '@/actions/Actions'
 // import the window like this so that it can be mocked during testing
 import { window } from '@/Window'
-import QueryStore, { getBBoxFromCoord, QueryPoint, QueryPointType, QueryStoreState } from '@/stores/QueryStore'
+import QueryStore, { QueryPoint, QueryPointType, QueryStoreState } from '@/stores/QueryStore'
 import MapOptionsStore, { MapOptionsStoreState } from './stores/MapOptionsStore'
-import { ApiImpl, getApi } from '@/api/Api'
+import { getApi } from '@/api/Api'
 import { AddressParseResult } from '@/pois/AddressParseResult'
-import { getQueryStore } from '@/stores/Stores'
+import { getBBoxFromCoord, getBBoxPoints } from '@/utils'
 
 export default class NavBar {
     private readonly queryStore: QueryStore
@@ -159,7 +159,7 @@ export default class NavBar {
         const bbox =
             initializedPoints.length == 1
                 ? getBBoxFromCoord(initializedPoints[0].coordinate)
-                : ApiImpl.getBBoxPoints(initializedPoints.map(p => p.coordinate))
+                : getBBoxPoints(initializedPoints.map(p => p.coordinate))
         if (bbox) Dispatcher.dispatch(new SetBBox(bbox))
         return Dispatcher.dispatch(new SetQueryPoints(points))
     }
diff --git a/src/actions/Actions.ts b/src/actions/Actions.ts
@@ -1,9 +1,10 @@
 import { Action } from '@/stores/Dispatcher'
-import { Coordinate, QueryPoint } from '@/stores/QueryStore'
+import { QueryPoint } from '@/stores/QueryStore'
 import { ApiInfo, Bbox, Path, RoutingArgs, RoutingProfile, RoutingResult } from '@/api/graphhopper'
 import { PathDetailsPoint } from '@/stores/PathDetailsStore'
 import { POI } from '@/stores/POIsStore'
 import { Settings } from '@/stores/SettingsStore'
+import { Coordinate } from '@/utils'
 
 export class InfoReceived implements Action {
     readonly result: ApiInfo
diff --git a/src/api/Api.ts b/src/api/Api.ts
@@ -17,7 +17,6 @@ import {
 import { LineString } from 'geojson'
 import { getTranslation, tr } from '@/translation/Translation'
 import * as config from 'config'
-import { Coordinate } from '@/stores/QueryStore'
 import { POIQuery } from '@/pois/AddressParseResult'
 
 interface ApiProfile {
@@ -445,7 +444,7 @@ export class ApiImpl implements Api {
 
     public static isMotorVehicle(profile: string) {
         return (
-            profile.includes('car') && !profile.includes('cargobike') ||
+            (profile.includes('car') && !profile.includes('cargobike')) ||
             profile.includes('truck') ||
             profile.includes('scooter') ||
             profile.includes('bus') ||
@@ -456,25 +455,4 @@ export class ApiImpl implements Api {
     public static isTruck(profile: string) {
         return profile.includes('truck')
     }
-
-    public static getBBoxPoints(points: Coordinate[]): Bbox | null {
-        const bbox: Bbox = points.reduce(
-            (res: Bbox, c) => [
-                Math.min(res[0], c.lng),
-                Math.min(res[1], c.lat),
-                Math.max(res[2], c.lng),
-                Math.max(res[3], c.lat),
-            ],
-            [180, 90, -180, -90] as Bbox
-        )
-        if (points.length == 1) {
-            bbox[0] = bbox[0] - 0.001
-            bbox[1] = bbox[1] - 0.001
-            bbox[2] = bbox[2] + 0.001
-            bbox[3] = bbox[3] + 0.001
-        }
-
-        // return null if the bbox is not valid, e.g. if no url points were given at all
-        return bbox[0] < bbox[2] && bbox[1] < bbox[3] ? bbox : null
-    }
 }
diff --git a/src/custom.d.ts b/src/custom.d.ts
@@ -5,9 +5,10 @@ declare module 'heightgraph/src/heightgraph'
 declare module 'custom-model-editor/src/index'
 
 declare module 'config' {
-    import ol from 'ol/dist/ol'
-    import array = ol.array
-    import { ProfileGroup, ProfileGroupMap } from '@/stores/QueryStore'
+    interface ProfileGroup {
+        readonly options: { profile: string }[]
+    }
+
     const routingApi: string
     const geocodingApi: string
     const defaultTiles: string
diff --git a/src/distUtils.ts b/src/distUtils.ts
diff --git a/src/map/findNextWayPoint.ts b/src/map/findNextWayPoint.ts
@@ -1,5 +1,4 @@
-import { Coordinate } from '@/stores/QueryStore'
-import { calcDist } from '@/distUtils'
+import { calcDist, Coordinate } from '@/utils'
 
 /**
  * Finds the way-point that follows the part of a route that is closest to a given location
diff --git a/src/pathDetails/PathDetails.tsx b/src/pathDetails/PathDetails.tsx
@@ -7,7 +7,7 @@ import Dispatcher from '@/stores/Dispatcher'
 import { PathDetailsElevationSelected, PathDetailsHover, PathDetailsRangeSelected } from '@/actions/Actions'
 import QueryStore, { Coordinate, QueryPointType } from '@/stores/QueryStore'
 import { Position } from 'geojson'
-import { calcDist } from '@/distUtils'
+import { calcDist } from '@/utils'
 import { tr } from '@/translation/Translation'
 import { SettingsContext } from '@/contexts/SettingsContext'
 
diff --git a/src/pois/AddressParseResult.ts b/src/pois/AddressParseResult.ts
@@ -1,10 +1,10 @@
-import { ApiImpl } from '@/api/Api'
 import Dispatcher from '@/stores/Dispatcher'
 import { SetBBox, SetPOIs } from '@/actions/Actions'
 import { hitToItem } from '@/Converters'
 import { GeocodingHit, ReverseGeocodingHit } from '@/api/graphhopper'
 import { tr, Translation } from '@/translation/Translation'
 import { POI } from '@/stores/POIsStore'
+import { getBBoxPoints } from '@/utils'
 
 export class AddressParseResult {
     location: string
@@ -144,7 +144,7 @@ export class AddressParseResult {
                     address: res.secondText,
                 } as POI
             })
-        const bbox = ApiImpl.getBBoxPoints(pois.map(p => p.coordinate))
+        const bbox = getBBoxPoints(pois.map(p => p.coordinate))
         if (bbox) {
             if (parseResult.location) Dispatcher.dispatch(new SetBBox(bbox))
             Dispatcher.dispatch(new SetPOIs(pois))
diff --git a/src/sidebar/CustomModelExamples.ts b/src/sidebar/CustomModelExamples.ts
@@ -1,4 +1,4 @@
-import { CustomModel } from '@/stores/QueryStore'
+import { CustomModel } from '@/utils'
 
 export const customModelExamples: { [key: string]: CustomModel } = {
     default_example: {
diff --git a/src/sidebar/RoutingResults.tsx b/src/sidebar/RoutingResults.tsx
@@ -10,7 +10,7 @@ import Details from '@/sidebar/list.svg'
 import GPXDownload from '@/sidebar/file_download.svg'
 import Instructions from '@/sidebar/instructions/Instructions'
 import { LineString, Position } from 'geojson'
-import { calcDist } from '@/distUtils'
+import { calcDist } from '@/utils'
 import { useMediaQuery } from 'react-responsive'
 import { tr } from '@/translation/Translation'
 import { ApiImpl } from '@/api/Api'
diff --git a/src/stores/QueryStore.ts b/src/stores/QueryStore.ts
@@ -18,37 +18,11 @@ import {
     SetQueryPoints,
     SetVehicleProfile,
 } from '@/actions/Actions'
-import { Bbox, RoutingArgs, RoutingProfile } from '@/api/graphhopper'
-import { calcDist } from '@/distUtils'
+import { RoutingArgs, RoutingProfile } from '@/api/graphhopper'
+import { calcDist, Coordinate, ProfileGroupMap } from '@/utils'
 import config from 'config'
 import { customModel2prettyString, customModelExamples } from '@/sidebar/CustomModelExamples'
 
-export interface Coordinate {
-    lat: number
-    lng: number
-}
-
-export function getBBoxFromCoord(c: Coordinate, offset: number = 0.005): Bbox {
-    return [c.lng - offset, c.lat - offset, c.lng + offset, c.lat + offset]
-}
-
-export class ProfileGroupMap {
-    public static create(map: Record<string, ProfileGroup>): Record<string, string> {
-        let res: Record<string, string> = {}
-        if (map)
-            for (const [key, value] of Object.entries(map)) {
-                for (const option of value.options) {
-                    res[option.profile] = key
-                }
-            }
-        return res
-    }
-}
-
-export interface ProfileGroup {
-    readonly options: { profile: string }[]
-}
-
 export interface QueryStoreState {
     readonly profiles: RoutingProfile[]
     readonly lastProfiles: Record<string, string>
@@ -70,13 +44,6 @@ export interface QueryPoint {
     readonly type: QueryPointType
 }
 
-export interface CustomModel {
-    readonly speed?: object[]
-    readonly priority?: object[]
-    readonly distance_influence?: number
-    readonly areas?: object
-}
-
 export enum QueryPointType {
     From,
     To,
diff --git a/src/utils.ts b/src/utils.ts
@@ -0,0 +1,78 @@
+import { Bbox } from '@/api/graphhopper'
+import { ProfileGroup } from 'config'
+
+export interface CustomModel {
+    readonly speed?: object[]
+    readonly priority?: object[]
+    readonly distance_influence?: number
+    readonly areas?: object
+}
+
+export interface Coordinate {
+    lat: number
+    lng: number
+}
+
+export function getBBoxFromCoord(c: Coordinate, offset: number = 0.005): Bbox {
+    return [c.lng - offset, c.lat - offset, c.lng + offset, c.lat + offset]
+}
+
+export function getBBoxPoints(points: Coordinate[]): Bbox | null {
+    const bbox: Bbox = points.reduce(
+        (res: Bbox, c) => [
+            Math.min(res[0], c.lng),
+            Math.min(res[1], c.lat),
+            Math.max(res[2], c.lng),
+            Math.max(res[3], c.lat),
+        ],
+        [180, 90, -180, -90] as Bbox
+    )
+    if (points.length == 1) {
+        bbox[0] = bbox[0] - 0.001
+        bbox[1] = bbox[1] - 0.001
+        bbox[2] = bbox[2] + 0.001
+        bbox[3] = bbox[3] + 0.001
+    }
+
+    // return null if the bbox is not valid, e.g. if no url points were given at all
+    return bbox[0] < bbox[2] && bbox[1] < bbox[3] ? bbox : null
+}
+
+export class ProfileGroupMap {
+    public static create(map: Record<string, ProfileGroup>): Record<string, string> {
+        let res: Record<string, string> = {}
+        if (map)
+            for (const [key, value] of Object.entries(map)) {
+                for (const option of value.options) {
+                    res[option.profile] = key
+                }
+            }
+        return res
+    }
+}
+
+/**
+ * Calculates the great-circle distance between two points on Earth given the latitudes and longitudes
+ * assuming that Earth is a sphere with radius 6371km. The result is returned in meters.
+ */
+export function calcDist(point1: Coordinate, point2: Coordinate): number {
+    const lat1 = point1.lat
+    const lat2 = point2.lat
+    const lon1 = point1.lng
+    const lon2 = point2.lng
+    const sinDeltaLat = Math.sin(toRad(lat2 - lat1) / 2)
+    const sinDeltaLon = Math.sin(toRad(lon2 - lon1) / 2)
+    return (
+        6371000 *
+        2 *
+        Math.asin(
+            Math.sqrt(
+                sinDeltaLat * sinDeltaLat + sinDeltaLon * sinDeltaLon * Math.cos(toRad(lat1)) * Math.cos(toRad(lat2))
+            )
+        )
+    )
+}
+
+export function toRad(deg: number): number {
+    return deg * 0.017453292519943295
+}
diff --git a/test/findNextWayPoint.test.ts b/test/findNextWayPoint.test.ts
@@ -1,5 +1,5 @@
-import { Coordinate } from '@/stores/QueryStore'
 import { findNextWayPoint } from '@/map/findNextWayPoint'
+import { Coordinate } from '@/utils'
 
 // test data, can be shown using these url parameters:
 // ?point=52.550,13.352&point=52.547,13.358&point=52.541,13.368&point=52.542,13.376&point=52.542,13.383
