Merge pull request #1323 from geoadmin/feat-pb-1383-messages-to-log-module

schtibe · web-flow · commit c9feb7d8386f · 2025-05-05T13:39:18.000+02:00
PB-1383 Refactor ErrorMessage and WarningMessage to @geoadmin/log
diff --git a/packages/geoadmin-log/package.json b/packages/geoadmin-log/package.json
@@ -8,6 +8,11 @@
             "types": "./dist/index.d.ts",
             "import": "./dist/index.js",
             "require": "./dist/index.umd.cjs"
+        },
+        "./Message": {
+            "types": "./dist/Message.d.ts",
+            "import": "./dist/Message.js",
+            "require": "./dist/Message.umd.js"
         }
     },
     "files": [
diff --git a/packages/geoadmin-log/src/Message.ts b/packages/geoadmin-log/src/Message.ts
@@ -1,20 +1,27 @@
-/** Error message to display to the user */
-export default class ErrorMessage {
+/** @module geoadmin/log */
+
+export class Message {
+    msg: string
+    params: Record<string, any>
+
     /**
      * @param {string} msg Translation key message
      * @param {any} params Translation params to pass to i18n (used for message formatting)
      */
-    constructor(msg, params = null) {
+    constructor(msg: string, params: Record<string, any> | null = null) {
         this.msg = msg
         this.params = params ?? {}
     }
 
-    isEquals(object) {
+    isEquals(object: Message) {
         return (
-            object instanceof ErrorMessage &&
+            object instanceof Message &&
             object.msg === this.msg &&
             Object.keys(this.params).length === Object.keys(object.params).length &&
             Object.keys(this.params).every((key) => this.params[key] === object.params[key])
         )
     }
 }
+
+export class ErrorMessage extends Message {}
+export class WarningMessage extends Message {}
diff --git a/packages/geoadmin-log/vite.config.js b/packages/geoadmin-log/vite.config.js
@@ -4,7 +4,10 @@ import dts from 'vite-plugin-dts'
 export default {
     build: {
         lib: {
-            entry: [resolve(__dirname, 'src/index.ts')],
+            entry: {
+                index: resolve(__dirname, 'src/index.ts'),
+                Message: resolve(__dirname, 'src/Message.ts'),
+            },
             name: '@geoadmin/log',
         },
         rollupOptions: {
diff --git a/packages/mapviewer/src/api/errorQueues.api.js b/packages/mapviewer/src/api/errorQueues.api.js
@@ -1,4 +1,4 @@
-import ErrorMessage from '@/utils/ErrorMessage.class'
+import { ErrorMessage } from '@geoadmin/log/Message'
 
 export function getStandardErrorMessage(query, urlParamName) {
     return new ErrorMessage('url_parameter_error', {
diff --git a/packages/mapviewer/src/modules/drawing/DrawingModule.vue b/packages/mapviewer/src/modules/drawing/DrawingModule.vue
@@ -1,5 +1,6 @@
 <script setup>
 import log from '@geoadmin/log'
+import { WarningMessage } from '@geoadmin/log/Message'
 import VectorLayer from 'ol/layer/Vector'
 import VectorSource from 'ol/source/Vector'
 import {
@@ -28,7 +29,6 @@ import { EditMode } from '@/store/modules/drawing.store'
 import { FeatureInfoPositions } from '@/store/modules/ui.store'
 import ModalWithBackdrop from '@/utils/components/ModalWithBackdrop.vue'
 import { getIcon, parseIconUrl } from '@/utils/kmlUtils'
-import WarningMessage from '@/utils/WarningMessage.class'
 
 const dispatcher = { dispatcher: 'DrawingModule.vue' }
 
diff --git a/packages/mapviewer/src/modules/map/components/cesium/CesiumWMTSLayer.vue b/packages/mapviewer/src/modules/map/components/cesium/CesiumWMTSLayer.vue
@@ -1,6 +1,7 @@
 <script setup>
 import { WGS84 } from '@geoadmin/coordinates'
 import log from '@geoadmin/log'
+import { ErrorMessage } from '@geoadmin/log/Message'
 import { Rectangle, UrlTemplateImageryProvider, WebMapTileServiceImageryProvider } from 'cesium'
 import { computed, inject, onBeforeUnmount, toRef, watch } from 'vue'
 import { useStore } from 'vuex'
@@ -9,7 +10,6 @@ import ExternalWMTSLayer, { WMTSEncodingTypes } from '@/api/layers/ExternalWMTSL
 import GeoAdminWMTSLayer from '@/api/layers/GeoAdminWMTSLayer.class'
 import { DEFAULT_PROJECTION } from '@/config/map.config'
 import useAddImageryLayer from '@/modules/map/components/cesium/utils/useAddImageryLayer.composable'
-import ErrorMessage from '@/utils/ErrorMessage.class'
 import { getWmtsXyzUrl } from '@/utils/layerUtils'
 
 const dispatcher = { dispatcher: 'CesiumWMTSLayer.vue' }
diff --git a/packages/mapviewer/src/modules/map/components/openlayers/OpenLayersKMLLayer.vue b/packages/mapviewer/src/modules/map/components/openlayers/OpenLayersKMLLayer.vue
@@ -2,6 +2,7 @@
 /** Renders a KML file on the map */
 
 import log from '@geoadmin/log'
+import { WarningMessage } from '@geoadmin/log/Message'
 import VectorLayer from 'ol/layer/Vector'
 import VectorSource from 'ol/source/Vector'
 import { computed, inject, onMounted, onUnmounted, watch } from 'vue'
@@ -11,7 +12,6 @@ import KMLLayer from '@/api/layers/KMLLayer.class'
 import { IS_TESTING_WITH_CYPRESS } from '@/config/staging.config'
 import useAddLayerToMap from '@/modules/map/components/openlayers/utils/useAddLayerToMap.composable'
 import { iconUrlProxyFy, parseKml } from '@/utils/kmlUtils'
-import WarningMessage from '@/utils/WarningMessage.class'
 
 const dispatcher = { dispatcher: 'OpenLayersKMLLayer.vue' }
 
diff --git a/packages/mapviewer/src/modules/menu/components/advancedTools/ImportFile/ImportFileOnlineTab.vue b/packages/mapviewer/src/modules/menu/components/advancedTools/ImportFile/ImportFileOnlineTab.vue
@@ -1,5 +1,6 @@
 <script setup>
 import log from '@geoadmin/log'
+import { WarningMessage } from '@geoadmin/log/Message'
 import { computed, onMounted, ref, useTemplateRef, watch } from 'vue'
 import { useStore } from 'vuex'
 
@@ -8,7 +9,6 @@ import generateErrorMessageFromErrorType from '@/modules/menu/components/advance
 import useImportFile from '@/modules/menu/components/advancedTools/ImportFile/useImportFile.composable'
 import TextInput from '@/utils/components/TextInput.vue'
 import { isValidUrl } from '@/utils/utils'
-import WarningMessage from '@/utils/WarningMessage.class'
 
 const { active } = defineProps({
     active: {
diff --git a/packages/mapviewer/src/modules/menu/components/advancedTools/ImportFile/parser/KMLParser.class.js b/packages/mapviewer/src/modules/menu/components/advancedTools/ImportFile/parser/KMLParser.class.js
@@ -1,4 +1,5 @@
 import { WGS84 } from '@geoadmin/coordinates'
+import { WarningMessage } from '@geoadmin/log/Message'
 
 import KMLLayer from '@/api/layers/KMLLayer.class'
 import EmptyFileContentError from '@/modules/menu/components/advancedTools/ImportFile/parser/errors/EmptyFileContentError.error'
@@ -7,7 +8,6 @@ import OutOfBoundsError from '@/modules/menu/components/advancedTools/ImportFile
 import FileParser from '@/modules/menu/components/advancedTools/ImportFile/parser/FileParser.class'
 import { getExtentIntersectionWithCurrentProjection } from '@/utils/extentUtils'
 import { getKmlExtent, isKmlFeaturesValid } from '@/utils/kmlUtils'
-import WarningMessage from '@/utils/WarningMessage.class'
 
 /**
  * Checks if file is KMLs
diff --git a/packages/mapviewer/src/modules/menu/components/advancedTools/ImportFile/parser/errors/generateErrorMessageFromErrorType.utils.js b/packages/mapviewer/src/modules/menu/components/advancedTools/ImportFile/parser/errors/generateErrorMessageFromErrorType.utils.js
@@ -1,9 +1,9 @@
+import { ErrorMessage } from '@geoadmin/log/Message'
 import { AxiosError } from 'axios'
 
 import EmptyFileContentError from '@/modules/menu/components/advancedTools/ImportFile/parser/errors/EmptyFileContentError.error'
 import OutOfBoundsError from '@/modules/menu/components/advancedTools/ImportFile/parser/errors/OutOfBoundsError.error'
 import UnknownProjectionError from '@/modules/menu/components/advancedTools/ImportFile/parser/errors/UnknownProjectionError.error'
-import ErrorMessage from '@/utils/ErrorMessage.class'
 
 /**
  * Generates an error message from the type of error received from a FileParser (or the parseAll
diff --git a/packages/mapviewer/src/modules/menu/components/advancedTools/ImportFile/useImportFile.composable.js b/packages/mapviewer/src/modules/menu/components/advancedTools/ImportFile/useImportFile.composable.js
@@ -1,11 +1,11 @@
 import log from '@geoadmin/log'
+import { WarningMessage } from '@geoadmin/log/Message'
 import { computed } from 'vue'
 import { useStore } from 'vuex'
 
 import { parseLayerFromFile } from '@/modules/menu/components/advancedTools/ImportFile/parser'
 import generateErrorMessageFromErrorType from '@/modules/menu/components/advancedTools/ImportFile/parser/errors/generateErrorMessageFromErrorType.utils'
 import { flattenExtent } from '@/utils/extentUtils'
-import WarningMessage from '@/utils/WarningMessage.class'
 
 const dispatcher = {
     dispatcher: 'useImportFile.composable',
diff --git a/packages/mapviewer/src/modules/menu/components/advancedTools/MenuAdvancedToolsList.vue b/packages/mapviewer/src/modules/menu/components/advancedTools/MenuAdvancedToolsList.vue
@@ -1,12 +1,12 @@
 <script setup>
+import { WarningMessage } from '@geoadmin/log/Message'
 import { computed } from 'vue'
 import { useStore } from 'vuex'
 
 import ImportCatalogue from '@/modules/menu/components/advancedTools/ImportCatalogue/ImportCatalogue.vue'
 import ImportFile from '@/modules/menu/components/advancedTools/ImportFile/ImportFile.vue'
 import MenuAdvancedToolsListItem from '@/modules/menu/components/advancedTools/MenuAdvancedToolsListItem.vue'
 import SimpleWindow from '@/utils/components/SimpleWindow.vue'
-import WarningMessage from '@/utils/WarningMessage.class'
 
 const dispatcher = { dispatcher: 'MenuAdvancedToolsList.vue' }
 
diff --git a/packages/mapviewer/src/router/storeSync/LayerParamConfig.class.js b/packages/mapviewer/src/router/storeSync/LayerParamConfig.class.js
@@ -1,4 +1,5 @@
 import log from '@geoadmin/log'
+import { ErrorMessage, WarningMessage } from '@geoadmin/log/Message'
 
 import { getStandardValidationResponse } from '@/api/errorQueues.api'
 import getFeature from '@/api/features/features.api'
@@ -17,10 +18,9 @@ import {
     parseLayersParam,
     transformLayerIntoUrlString,
 } from '@/router/storeSync/layersParamParser'
-import ErrorMessage from '@/utils/ErrorMessage.class'
 import { flattenExtent } from '@/utils/extentUtils'
 import { getExtentOfGeometries } from '@/utils/geoJsonUtils'
-import WarningMessage from '@/utils/WarningMessage.class'
+
 /**
  * Parse layers such as described in
  * https://github.com/geoadmin/web-mapviewer/blob/develop/adr/2021_03_16_url_param_structure.md#layerid
diff --git a/packages/mapviewer/src/router/storeSync/TimeSliderParamConfig.class.js b/packages/mapviewer/src/router/storeSync/TimeSliderParamConfig.class.js
@@ -1,9 +1,9 @@
+import { WarningMessage } from '@geoadmin/log/Message'
+
 import { getStandardValidationResponse } from '@/api/errorQueues.api'
 import AbstractParamConfig, {
     STORE_DISPATCHER_ROUTER_PLUGIN,
 } from '@/router/storeSync/abstractParamConfig.class'
-import WarningMessage from '@/utils/WarningMessage.class'
-
 function dispatchTimeSliderFromUrlParam(to, store, urlParamValue) {
     const promisesForAllDispatch = []
     if (
diff --git a/packages/mapviewer/src/store/modules/layers.store.js b/packages/mapviewer/src/store/modules/layers.store.js
@@ -1,10 +1,10 @@
 import { WGS84 } from '@geoadmin/coordinates'
 import log from '@geoadmin/log'
+import { ErrorMessage } from '@geoadmin/log/Message'
 
 import AbstractLayer from '@/api/layers/AbstractLayer.class'
 import LayerTypes from '@/api/layers/LayerTypes.enum'
 import { DEFAULT_OLDEST_YEAR, DEFAULT_YOUNGEST_YEAR } from '@/config/time.config'
-import ErrorMessage from '@/utils/ErrorMessage.class'
 import { getExtentIntersectionWithCurrentProjection } from '@/utils/extentUtils'
 import { getGpxExtent } from '@/utils/gpxUtils'
 import { getKmlExtent, parseKmlName } from '@/utils/kmlUtils'
diff --git a/packages/mapviewer/src/store/modules/ui.store.js b/packages/mapviewer/src/store/modules/ui.store.js
@@ -1,4 +1,5 @@
 import log from '@geoadmin/log'
+import { ErrorMessage, WarningMessage } from '@geoadmin/log/Message'
 import { isNumber } from '@geoadmin/numbers'
 
 import { BREAKPOINT_TABLET, MAX_WIDTH_SHOW_FLOATING_TOOLTIP } from '@/config/responsive.config'
@@ -8,8 +9,6 @@ import {
     REPORT_PROBLEM_HOSTNAMES,
     WARNING_RIBBON_HOSTNAMES,
 } from '@/config/staging.config'
-import ErrorMessage from '@/utils/ErrorMessage.class'
-import WarningMessage from '@/utils/WarningMessage.class'
 
 const MAP_LOADING_BAR_REQUESTER = 'app-map-loading'
 
diff --git a/packages/mapviewer/src/store/plugins/external-layers.plugin.js b/packages/mapviewer/src/store/plugins/external-layers.plugin.js
@@ -7,11 +7,11 @@
  */
 
 import log from '@geoadmin/log'
+import { ErrorMessage } from '@geoadmin/log/Message'
 
 import ExternalWMSLayer from '@/api/layers/ExternalWMSLayer.class'
 import ExternalWMTSLayer from '@/api/layers/ExternalWMTSLayer.class'
 import { readWmsCapabilities, readWmtsCapabilities } from '@/api/layers/layers-external.api'
-import ErrorMessage from '@/utils/ErrorMessage.class'
 
 const dispatcher = { dispatcher: 'external-layers.plugin' }
 
diff --git a/packages/mapviewer/src/store/plugins/geolocation-management.plugin.js b/packages/mapviewer/src/store/plugins/geolocation-management.plugin.js
@@ -1,12 +1,12 @@
 import { LV95, WGS84 } from '@geoadmin/coordinates'
 import log from '@geoadmin/log'
+import { ErrorMessage } from '@geoadmin/log/Message'
 import { round } from '@geoadmin/numbers'
 import { Math as CesiumMath } from 'cesium'
 import { isEqual } from 'lodash'
 import proj4 from 'proj4'
 
 import { IS_TESTING_WITH_CYPRESS } from '@/config/staging.config'
-import ErrorMessage from '@/utils/ErrorMessage.class'
 
 const { GeolocationPositionError } = window
 
diff --git a/packages/mapviewer/src/store/plugins/load-geojson-style-and-data.plugin.js b/packages/mapviewer/src/store/plugins/load-geojson-style-and-data.plugin.js
@@ -4,10 +4,10 @@
  */
 
 import log from '@geoadmin/log'
+import { ErrorMessage } from '@geoadmin/log/Message'
 import axios from 'axios'
 
 import GeoAdminGeoJsonLayer from '@/api/layers/GeoAdminGeoJsonLayer.class'
-import ErrorMessage from '@/utils/ErrorMessage.class'
 
 const dispatcher = { dispatcher: 'load-geojson-style-and-data.plugin' }
 
diff --git a/packages/mapviewer/src/store/plugins/load-gpx-data.plugin.js b/packages/mapviewer/src/store/plugins/load-gpx-data.plugin.js
@@ -4,10 +4,10 @@
  */
 
 import log from '@geoadmin/log'
+import { ErrorMessage } from '@geoadmin/log/Message'
 
 import GPXLayer from '@/api/layers/GPXLayer.class'
 import GPXParser from '@/modules/menu/components/advancedTools/ImportFile/parser/GPXParser.class'
-import ErrorMessage from '@/utils/ErrorMessage.class'
 
 const dispatcher = { dispatcher: 'load-gpx-data.plugin' }
 
diff --git a/packages/mapviewer/src/store/plugins/load-kml-kmz-data.plugin.js b/packages/mapviewer/src/store/plugins/load-kml-kmz-data.plugin.js
@@ -4,14 +4,14 @@
  */
 
 import log from '@geoadmin/log'
+import { ErrorMessage } from '@geoadmin/log/Message'
 
 import { getFileContentThroughServiceProxy } from '@/api/file-proxy.api'
 import { checkOnlineFileCompliance, getFileContentFromUrl, loadKmlMetadata } from '@/api/files.api'
 import KMLLayer from '@/api/layers/KMLLayer.class'
 import generateErrorMessageFromErrorType from '@/modules/menu/components/advancedTools/ImportFile/parser/errors/generateErrorMessageFromErrorType.utils'
 import { KMLParser } from '@/modules/menu/components/advancedTools/ImportFile/parser/KMLParser.class'
 import KMZParser from '@/modules/menu/components/advancedTools/ImportFile/parser/KMZParser.class'
-import ErrorMessage from '@/utils/ErrorMessage.class'
 
 const dispatcher = { dispatcher: 'load-kml-kmz-data.plugin' }
 
@@ -99,7 +99,9 @@ async function loadData(store, kmlLayer) {
             layerId: kmlLayer.id,
             isExternal: kmlLayer.isExternal,
             baseUrl: kmlLayer.baseUrl,
-            error: new ErrorMessage(kmlLayer.isExternal ? 'loading_error_network_failure' : 'loading_error_file_deleted'),
+            error: new ErrorMessage(
+                kmlLayer.isExternal ? 'loading_error_network_failure' : 'loading_error_file_deleted'
+            ),
             ...dispatcher,
         })
         // stopping there, there won't be anything to do with this file
diff --git a/packages/mapviewer/src/utils/WarningMessage.class.js b/packages/mapviewer/src/utils/WarningMessage.class.js
diff --git a/packages/mapviewer/src/utils/components/ExtLayerInfoButton.vue b/packages/mapviewer/src/utils/components/ExtLayerInfoButton.vue
@@ -1,13 +1,11 @@
 <script setup lang="ts">
+import { ErrorMessage, WarningMessage } from '@geoadmin/log/Message'
 import GeoadminTooltip from '@geoadmin/tooltip'
 import { computed, useTemplateRef } from 'vue'
 import { useI18n } from 'vue-i18n'
 
 import type AbstractLayer from '@/api/layers/AbstractLayer.class.js'
 
-import ErrorMessage from '@/utils/ErrorMessage.class'
-import WarningMessage from '@/utils/WarningMessage.class'
-
 const { showSpinner, layer, index } = defineProps<{
     showSpinner: boolean
     layer: AbstractLayer
@@ -26,12 +24,12 @@ const hasWarning = computed((): boolean => {
 
 const theme = computed(() => {
     if (hasError.value) {
-        return "danger"
+        return 'danger'
     }
     if (hasWarning.value) {
-        return "warning"
+        return 'warning'
     }
-    return "light"
+    return 'light'
 })
 const tooltipContent = computed((): string => {
     if (hasError.value) {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import ErrorMessage from '@/utils/ErrorMessage.class'`
	`1`	`+import { ErrorMessage } from '@geoadmin/log/Message'`
`2`	`2`
`3`	`3`	`export function getStandardErrorMessage(query, urlParamName) {`
`4`	`4`	`return new ErrorMessage('url_parameter_error', {`